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

Add contribution guidelines #264

Merged
merged 6 commits into from
Jun 19, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,34 @@ use GitHub pull requests for this purpose. Consult [GitHub
Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

### Contribution guidelines and standards

Before sending your pull request for
[review](https://github.com/tensorflow/swift-apis/pulls),
make sure your changes are consistent with the guidelines.

#### Testing

* Include unit tests when you contribute new features, as they help to a)
prove that your code works correctly, and b) guard against future breaking
changes to lower the maintenance cost.
* Bug fixes also generally require unit tests, because the presence of bugs
usually indicates insufficient test coverage.

#### License

Include a license at the top of new files.
* [License example](https://github.com/tensorflow/swift-apis/blob/master/Sources/TensorFlow/Random.swift)

#### Swift coding style

Changes should conform to:

* [Google Swift Style Guide](https://google.github.io/swift/)
* [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/)

With the exception that 4-space indendation be used.

## Community

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