-
Notifications
You must be signed in to change notification settings - Fork 829
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CONTRIBUTING.md update with some more best practices. #2301
Conversation
… google style guide
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.
|
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's do separate since the title reflects this PR well :)
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.