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
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dan-zheng
suggested changes
Dec 20, 2019
Co-Authored-By: Dan Zheng <[email protected]>
Co-Authored-By: Dan Zheng <[email protected]>
Reference Swift API Design Guidelines: https://swift.org/documentation/api-design-guidelines/#write-doc-comment
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A few suggestions:
Update as per @saeta 's proposal here:
https://groups.google.com/a/tensorflow.org/d/msg/swift/tQKFYL1Ykac/21eYYC3pBgAJ
and this API docs PR thread here:
[WIP] Equations for losses #579
to advise contributors to mirror TF 2.x API docs closely, etc.
Add one paragraph almost word-for-word from TF 2.x API docs CONTRIBUTING.md ("When you contribute a new feature...") from
https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution
Any questions, amendment proposals, let me know. Thanks everyone