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

Update CONTRIBUTING.md for Swift for TensorFlow /swift-apis #589

Merged
merged 8 commits into from
Dec 22, 2019
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Contributing guidelines

## Welcome!

`swift-apis` is a carefully curated set of maintained APIs and functionality.
We generally aim to incubate new features in the library ecosystem that builds
on top of Swift for TensorFlow. Popular functionality, such as new layers or
helpful abstractions, often graduate into `swift-apis` after maturing in other
repositories first (e.g. `swift-models`), where the development team and the
community can try them out in context and iterate quickly.

## How to become a contributor and submit your own code

### Contributor License Agreements
Expand Down Expand Up @@ -59,6 +68,23 @@ Changes should conform to:

With the exception that 4-space indendation be used.

#### API documentation guidelines

API documentation should follow guidelines from the
["Write a documentation comment"](https://swift.org/documentation/api-design-guidelines/#write-doc-comment)
section of the Swift API Design Guidelines:

> * **Use Swift’s
> [dialect of Markdown](https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref)**.
> * **Begin with a summary** that describes the entity being declared. Often,
> an API can be completely understood from its declaration and its summary.
> * **Optionally, continue** with one or more paragraphs and bullet items.
> Paragraphs are separated by blank lines and use complete sentences.

For APIs ported from Python TensorFlow, use the API documentation from
[tensorflow.org/api_docs](https://www.tensorflow.org/api_docs) (e.g. function
parameter descriptions) as a starting point.

## Community

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