Skip to content
This repository was archived by the owner on Jul 1, 2023. It is now read-only.

Commit c9b0a0d

Browse files
8bitmp3dan-zheng
authored andcommitted
Update CONTRIBUTING.md (#589)
Add welcome paragraph and API documentation guidelines. Mailing list discussion: https://groups.google.com/a/tensorflow.org/forum/#!msg/swift/tQKFYL1Ykac/21eYYC3pBgAJ
1 parent 01c94b5 commit c9b0a0d

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Contributing guidelines
22

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+
312
## How to become a contributor and submit your own code
413

514
### Contributor License Agreements
@@ -59,6 +68,23 @@ Changes should conform to:
5968

6069
With the exception that 4-space indendation be used.
6170

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+
6288
## Community
6389

6490
It's a good idea to discuss any non-trivial submissions with the project

0 commit comments

Comments
 (0)