joao-r-reis commented on code in PR #1835: URL: https://github.com/apache/cassandra-gocql-driver/pull/1835#discussion_r1815036821
########## CONTRIBUTING.md: ########## @@ -23,21 +37,72 @@ The following is a check list of requirements that need to be satisfied in order * Notable changes (i.e. new features or changed behavior, bugfixes) are appropriately documented in CHANGELOG.md, functional changes also in godoc * A correctly formatted commit message, see below -If there are any requirements that can't be reasonably satisfied, please state this either on the pull request or as part of discussion on the mailing list. Where appropriate, the core team may apply discretion and make an exception to these requirements. +If there are any requirements that can't be reasonably satisfied, please state this either on the pull request or as part of discussion on the mailing list, JIRA or slack. Where appropriate, the core team may apply discretion and make an exception to these requirements. ## Commit Message -The Apache Cassandra project has a commit message precendence like +The commit message format should be: + ``` -<One sentence description, usually Jira title or CHANGES.txt summary> +<short description> + +<reason why the change is needed> - patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-##### +Patch by <authors>; reviewed by <Reviewers> for CASSGO-##### ``` -The 'patch by …; reviewed by' line is important. It permits our review-than-commit procedure, allowing commits from non-git-branch patches. It is also parsed to build the project contribulyse statistics found [here](https://nightlies.apache.org/cassandra/devbranch/misc/contribulyze/html/). +Short description should: +* Be a short sentence. +* Start with a capital letter. +* Be written in the present tense. +* Summarize what is changed, not why it is changed. +Short description should not: +* End with a period. +* Use the word Fixes . Most commits fix something. + +Long description / Reason: +* Should describe why the change is needed. What is fixed by the change? Why it it was broken before? What use case does the new feature solve? +* Consider adding details of other options that you considered when implementing the change and why you made the design decisions you made. + +The `patch by …; reviewed by` line is important. It is parsed to build the project contribulyse statistics found [here](https://nightlies.apache.org/cassandra/devbranch/misc/contribulyze/html/). Review Comment: done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
