martin-sucha commented on code in PR #1835: URL: https://github.com/apache/cassandra-gocql-driver/pull/1835#discussion_r1814940576
########## CONTRIBUTING.md: ########## @@ -1,20 +1,34 @@ # Contributing to the Apache Cassandra GoCQL Driver -**TL;DR** - this manifesto sets out the bare minimum requirements for submitting a patch to gocql. +**TL;DR** This manifesto sets out the bare minimum requirements for submitting a patch to gocql. It also offers some suggestions to speed up the review, approve and merge process. This guide outlines the process of landing patches in gocql and the general approach to maintaining the code base. ## Background -The goal of the gocql project is to provide a stable and robust CQL driver for Go. This is a community driven project that is coordinated by a small team of developers in and around the Apache Cassandra project. For security, governance and administration issues please refer to the Cassandra Project Management Committee. +The goal of the gocql project is to provide a stable and robust CQL driver for Go. This is a community driven project that is coordinated by a small team of developers in and around the Apache Cassandra project. For security, governance and administration issues please refer to the Cassandra Project Management Committee. + +## Engage with the community early + +If you are interested in contributing a particular feature or bug fix we heavily encourage you to start a discussion with the community or at the very least announce your interest in working on it before jumping right into writing code. It helps reduce the likelihood of multiple people working on the same issue in parallel when they could be collaborating instead. Getting feedback early in the contribution process will also greatly speed up the review, approval and merge process. + +Common ways to engage with the GoCQL community are: + +- CASSGO project on ASF JIRA Review Comment: Please add hyperlinks so it is easier to find the resources. ########## 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 Review Comment: Aren't CHANGES.txt and CHANGELOG.md redundant? ########## 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: Removing the "here" and making "project contribulyse statistics" a hyperlink would be a little bit more readable: ``` The `patch by …; reviewed by` line is important. It is parsed to build the [project contribulyse statistics](https://nightlies.apache.org/cassandra/devbranch/misc/contribulyze/html/). ``` -- 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]
