|
1 | 1 | # Contributing guidelines
|
2 | 2 |
|
| 3 | +## Welcome! |
| 4 | + |
| 5 | +`swift-apis` is a carefully curated set of maintained APIs and functionality. |
| 6 | +We generally aim to incubate new features in the library ecosystem that builds |
| 7 | +on top of Swift for TensorFlow. Popular functionality, such as new layers or |
| 8 | +helpful abstractions, often graduate into `swift-apis` after maturing in other |
| 9 | +repositories first (e.g. `swift-models`), where the development team and the |
| 10 | +community can try them out in context and iterate quickly. |
| 11 | + |
3 | 12 | ## How to become a contributor and submit your own code
|
4 | 13 |
|
5 | 14 | ### Contributor License Agreements
|
@@ -59,6 +68,23 @@ Changes should conform to:
|
59 | 68 |
|
60 | 69 | With the exception that 4-space indendation be used.
|
61 | 70 |
|
| 71 | +#### API documentation guidelines |
| 72 | + |
| 73 | +API documentation should follow guidelines from the |
| 74 | +["Write a documentation comment"](https://swift.org/documentation/api-design-guidelines/#write-doc-comment) |
| 75 | +section of the Swift API Design Guidelines: |
| 76 | + |
| 77 | +> * **Use Swift’s |
| 78 | +> [dialect of Markdown](https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref)**. |
| 79 | +> * **Begin with a summary** that describes the entity being declared. Often, |
| 80 | +> an API can be completely understood from its declaration and its summary. |
| 81 | +> * **Optionally, continue** with one or more paragraphs and bullet items. |
| 82 | +> Paragraphs are separated by blank lines and use complete sentences. |
| 83 | +
|
| 84 | +For APIs ported from Python TensorFlow, use the API documentation from |
| 85 | +[tensorflow.org/api_docs](https://www.tensorflow.org/api_docs) (e.g. function |
| 86 | +parameter descriptions) as a starting point. |
| 87 | + |
62 | 88 | ## Community
|
63 | 89 |
|
64 | 90 | It's a good idea to discuss any non-trivial submissions with the project
|
|
0 commit comments