Skip to content

Commit 32b3c9b

Browse files
author
Itai Ferber
committed
Update guidelines to more aggressively push using/updating status document
1 parent d981746 commit 32b3c9b

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CONTRIBUTING.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Contributions to Foundation are welcome! This project follows the [contribution guidelines for the Swift project](https://swift.org/contributing/#contributing-code). A few additional details are outlined below.
3+
Contributions to Foundation are welcome! This project follows the [contribution guidelines for the Swift project](https://swift.org/contributing/#contributing-code). If you are interested in contributing, please consult with our [status page](Docs/Status.md) to see what work remains to be done. A few additional details are outlined below.
44

55
## Licensing
66

@@ -36,6 +36,9 @@ All pull requests which contain code changes should come with a new set of autom
3636

3737
Most of the methods in Foundation are lacking documentation. We appreciate your help in filling out documentation when you implement a method. Use the markdown syntax in the [Swift Naming Guidelines](https://swift.org/documentation/api-design-guidelines.html#write-doc-comment).
3838

39+
##### Implementation Status
40+
We are currently keeping track of the implementation status and test coverage status of our public classes on our [status page](Docs/Status.md). If you make changes to our public interfaces, please take care to update the corresponding entries in that document.
41+
3942
## API Changes
4043

4144
The interface of Foundation is intended to be both stable and cross-platform. This means that when API is added to Foundation, it is effectively permanent.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You will want to use the [Swift Package Manager](https://swift.org/package-manag
5050

5151
## Working on Foundation
5252

53-
For information on how to build Foundation, please see [Getting Started](Docs/GettingStarted.md). Once you're ready to make changes of your own, check out our [information on contributing](CONTRIBUTING.md).
53+
For information on how to build Foundation, please see [Getting Started](Docs/GettingStarted.md). If you would like, please consult our [status page](Docs/Status.md) to see where you can make the biggest impact, and once you're ready to make changes of your own, check out our [information on contributing](CONTRIBUTING.md).
5454

5555
## FAQ
5656

0 commit comments

Comments
 (0)