[DOCS] Adding coding guidelines #2061
Merged
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
yanghua
reviewed
Sep 2, 2020
Contributor
yanghua
left a comment
yanghua
left a comment
There was a problem hiding this comment.
Left some minor comments.
docs/_pages/contributing.md
Outdated
Contributor
There was a problem hiding this comment.
non-backwards -> non-backward?
Member
Author
There was a problem hiding this comment.
i have seen both. keeping the s
bvaradar
approved these changes
Sep 2, 2020
Contributor
bvaradar
left a comment
bvaradar
left a comment
There was a problem hiding this comment.
Nice writeup. Overall looks good to me.
nsivabalan
reviewed
Sep 3, 2020
docs/_pages/contributing.md
Outdated
Contributor
There was a problem hiding this comment.
do we have any guidelines for ordering or public, package private and private method. Also, in tests, actual test methods and private/utility methods and assertion methods.
Member
Author
There was a problem hiding this comment.
this would go counter to that sort of ordering. most of this is distilled from the clean code book, which recomments logical grouping by cohesion, rather than artificially by private/public
vinothchandar
force-pushed
the
asf-site
branch
from
1f8bd45 to
64d33f4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Tips
What is the purpose of the pull request
(For example: This pull request adds quick-start document.)
Brief change log
(for example:)
Verify this pull request
(Please pick either of the following options)
This pull request is a trivial rework / code cleanup without any test coverage.
(or)
This pull request is already covered by existing tests, such as (please describe tests).
(or)
This change added tests and can be verified as follows:
(example:)
Committer checklist
Has a corresponding JIRA in PR title & commit
Commit message is descriptive of the change
CI is green
Necessary doc changes done or have another open PR
For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.