CONTRIBUTING.md update with some more best practices. #2301
Conversation
This file contains 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
… google style guide
jkwatson
requested review from
anuraaga,
arminru,
bogdandrutu,
carlosalberto,
Oberon00,
pavolloffay,
thisthat and
tylerbenson
as code owners
Codecov Report
@@ Coverage Diff @@
## master #2301 +/- ##
=============================================
+ Coverage 0 87.72% +87.72%
- Complexity 0 2429 +2429
=============================================
Files 0 270 +270
Lines 0 8163 +8163
Branches 0 906 +906
=============================================
+ Hits 0 7161 +7161
- Misses 0 671 +671
- Partials 0 331 +331
Continue to review full report at Codecov.
|
jkwatson
changed the title
anuraaga
approved these changes
Dec 15, 2020
anuraaga
reviewed
Dec 15, 2020
bogdandrutu
approved these changes
Dec 15, 2020
bogdandrutu
approved these changes
Dec 15, 2020
Comment on lines
+77
to
+78
| * Adding `toString()` overrides on classes is encouraged, but we only use `toString()` to provide debugging assistance. The implementations | ||
| of all `toString()` methods should be considered to be unstable unless explicitly documented otherwise. |
There was a problem hiding this comment.
This is not very visible for the users of the API. Consider to add similar statement in the API readme? Or package info?
There was a problem hiding this comment.
Agreed. Probably both in the readme and the package info. I can add that to this PR, or create a separate one, your call.
There was a problem hiding this comment.
Let's do separate since the title reflects this PR well :)
carlosalberto
approved these changes
Dec 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a section about class member ordering, since it's not covered in the google style guide, seemed like a good idea to document it, so we don't need to argue about it.
Also adds a line about the instability of
toString()methods.