Skip to content

Commit d981746

Browse files
author
Itai Ferber
committed
Add status table key for contributors
1 parent 6c6b9d5 commit d981746

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Docs/Status.md

+19
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@ Foundation is divided into groups of related functionality. These groups are cur
66

77
As Foundation is a work in progress, not all methods and functionality are present. When implementations are completed, this list should be updated to reflect the current state of the library.
88

9+
#### Table Key
10+
11+
##### Implementation Status
12+
* _N/A_: This entity is internal or private and implemented ad hoc; there are no guidelines in place to suggest what completion might look like
13+
* _Unimplemented_: This entity exists, but all functions and methods are `NSUnimplemented()`
14+
* _Incomplete_: Implementation of this entity has begun, but critical sections have been left `NSUnimplemented()`
15+
* _Mostly Complete_: All critical sections of this entity have been implemented, but some methods might remain `NSUnimplemented()`
16+
* _Complete_: All functionality is implemented
17+
18+
##### Test Coverage
19+
* _N/A_: This entity is internal and public tests are inappropriate, or it is an entity for which testing does not make sense
20+
* _None_: There are no unit tests specific to this entity; even if it is used indirectly in other unit tests, we should have tests targeting this entity in isolation
21+
* _Incomplete_: Unit tests exist for this entity, but there are critical paths that are not being tested
22+
* _Substantial_: Most, if not all, of this entity's critical paths are being tested
23+
24+
There is no _Complete_ status for test coverage because there are always additional tests to be implemented. Even entities with _Substantial_ coverage are missing tests (e.g. `NSCoding` conformance, `NSCopying` conformance, `description`s, etc.)
25+
26+
### Entities
27+
928
* **Runtime**: The basis for interoperability.
1029
The classes and methods in this group provide an interface for interoperability between C code and Swift. They also provide common layers used throughout the framework such as the root class `NSObject`.
1130

0 commit comments

Comments
 (0)