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

Commit ec7f583

Browse files
jon-towrxwei
authored andcommitted
Add contribution guidelines (#264)
1 parent 5fa5d5c commit ec7f583

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,34 @@ use GitHub pull requests for this purpose. Consult [GitHub
3131
Help](https://help.github.com/articles/about-pull-requests/) for more
3232
information on using pull requests.
3333

34+
### Contribution guidelines and standards
35+
36+
Before sending your pull request for
37+
[review](https://github.com/tensorflow/swift-apis/pulls),
38+
make sure your changes are consistent with the guidelines.
39+
40+
#### Testing
41+
42+
* Include unit tests when you contribute new features, as they help to a)
43+
prove that your code works correctly, and b) guard against future breaking
44+
changes to lower the maintenance cost.
45+
* Bug fixes also generally require unit tests, because the presence of bugs
46+
usually indicates insufficient test coverage.
47+
48+
#### License
49+
50+
Include a license at the top of new files.
51+
* [License example](https://github.com/tensorflow/swift-apis/blob/master/Sources/TensorFlow/Random.swift)
52+
53+
#### Swift coding style
54+
55+
Changes should conform to:
56+
57+
* [Google Swift Style Guide](https://google.github.io/swift/)
58+
* [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/)
59+
60+
With the exception that 4-space indendation be used.
61+
3462
## Community
3563

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

0 commit comments

Comments
 (0)