This is an automated email from the ASF dual-hosted git repository. vatamane pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/couchdb.git
commit 5777fd2457052663d409862427c41a546bcd1cc6 Author: Ronny <[email protected]> AuthorDate: Wed Feb 9 13:25:03 2022 +0100 Adding commit message conventions and update links Added the commit message conventions from the proposal of discussion #3918 and updated all links to use https and moved all external links to the end of the file --- CONTRIBUTING.md | 111 ++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 76 insertions(+), 35 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ac0c89..d575067 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,18 +11,18 @@ changes, and helping you finalize your pull requests. Contributions to CouchDB are governed by our [Code of Conduct][6] and a set of [Project Bylaws][7]. Come join us! - ## Using the issue tracker First things first: **Do NOT report security vulnerabilities in public issues!** -Please disclose responsibly by letting [the Apache CouchDB Security team](mailto:[email protected]?subject=Security) +Please disclose responsibly by letting [the Apache CouchDB Security team][11] know upfront. We will assess the issue as soon as possible on a best-effort basis and will give you an estimate for when we have a fix and release available for an eventual public disclosure. -The [GitHub issue tracker][#bugs_and_feature] is the preferred channel for [bug reports](#bug-reports), -[features requests](#feature-requests) and [submitting pull requests](#pull-requests), -but please respect the following restrictions: +The [GitHub issue tracker][#gh_issues] is the preferred channel for +[bug reports](#bug-reports), [features requests](#feature-requests) +and [submitting pull requests](#pull-requests), but please respect +the following restrictions: * Please **do not** use the issue tracker for personal support requests. Use [CouchDB Chat][8] instead. Alternately, help us to help more people by @@ -31,7 +31,6 @@ but please respect the following restrictions: * Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. - ## Bug reports A bug is a _demonstrable problem_ that is caused by the code in our @@ -72,7 +71,6 @@ Example: > causing the bug, and potential solutions (and your opinions on their > merits). - ## Feature requests Feature requests are welcome. But take a moment to find out whether your idea @@ -80,7 +78,6 @@ fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible. - ## Pull requests Good pull requests - patches, improvements, new features - are a fantastic @@ -94,13 +91,46 @@ into the project. You can talk with the community on our [developer mailing list][5]. We're always open to suggestions and will get back to you as soon as we can! +### CouchDB commit message conventions + +A well-crafted Git commit message is the best way to communicate context about a +change to other developers working on that project, and indeed, to your future self. + +Commit messages can adequately communicate why a change was made, and understanding +that makes development and collaboration more efficient. + +Here's a great template of a good commit message + +``` +Capitalized, short (50 chars or less) summary + +More detailed explanatory text, if necessary. Wrap it to about 72 +characters or so. In some contexts, the first line is treated as the +subject of an email and the rest of the text as the body. The blank +line separating the summary from the body is critical (unless you omit +the body entirely); tools like rebase can get confused if you run the +two together. + +Write your commit message in the imperative: "Fix bug" and not "Fixed bug" +or "Fixes bug." This convention matches up with commit messages generated +by commands like git merge and git revert. + +Further paragraphs come after blank lines. + +- Bullet points are okay, too + +- Typically a hyphen or asterisk is used for the bullet, followed by a + single space, with blank lines in between, but conventions vary here + +- Use a hanging indent +``` ### For new Contributors -If you never created a pull request before, welcome :tada: :smile: [Here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) -on how to send one :) +If you never created a pull request before, welcome :tada: :smile: +[Here is a great tutorial][12] on how to send one :) -1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, +1. [Fork][13] the project, clone your fork, and configure the remotes: ```bash @@ -132,7 +162,7 @@ on how to send one :) the project’s README for more information. 5. If you added or changed a feature, make sure to document it accordingly in - the [CouchDB documentation](https://github.com/apache/couchdb-documentation) + the [CouchDB documentation][14] repository. 6. Push your topic branch up to your fork: @@ -141,14 +171,13 @@ on how to send one :) git push origin <topic-branch-name> ``` -8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) +8. [Open a Pull Request][15] with a clear title and description. - ### For Apache CouchDB Committers -1. Be sure to set up [GitHub two-factor authentication](https://help.github.com/articles/about-two-factor-authentication/), - then [link your Apache account to your GitHub account](https://gitbox.apache.org/setup/). +1. Be sure to set up [GitHub two-factor authentication][16], + then [link your Apache account to your GitHub account][17]. You will need to wait about 30 minutes after completing this process for it to complete. Follow the instructions in the organisational invite email you receive. Alternately, you can use the Apache mirror @@ -170,8 +199,7 @@ on how to send one :) the project’s README for more information. 4. If you added or changed a feature, make sure to document it accordingly in - the [CouchDB documentation](https://github.com/apache/couchdb-documentation) - repository. + the [CouchDB documentation][14] repository. 5. Push your topic branch up to our repo @@ -195,12 +223,11 @@ complicated, we can help you out and teach you as we go :) Afterwards force push your changes to your remote feature branch. 2. Once a pull request is good to go, you can tidy up your commit messages using - Git's [interactive rebase](https://help.github.com/articles/interactive-rebase). + Git's [interactive rebase][18]. **IMPORTANT**: By submitting a patch, you agree to license your work under the Apache License, per your signed Apache CLA. - ## Triagers Apache CouchDB committers who have completed the GitHub account linking @@ -209,16 +236,15 @@ user and developer pain in working through our backlog. Briefly, to triage an issue, review the report, validate that it is an actual issue (reproducing if possible), and add one or more labels. We have a -[summary of our label taxonomy](https://github.com/apache/couchdb/issues/499) -for your reference. +[summary of our label taxonomy][19] for your reference. If you are not an official committer, please reach out to our [mailing list][5] or [chat][8] to learn how you can assist with triaging indirectly. - ## Maintainers -If you have commit access, please follow this process for merging patches and cutting new releases. +If you have commit access, please follow this process for merging patches and cutting +new releases. ### Reviewing changes @@ -235,7 +261,7 @@ If you have commit access, please follow this process for merging patches and cu Leave a comment about it so the author and others will know. 7. Once everything looks good, add an "Approve" review. Don’t forget to say something nice 👏🐶💖✨ -8. If the commit messages follow [our conventions](@commit-message-conventions) +8. If the commit messages follow [our conventions](#couchdb-commit-message-conventions) 1. If the pull request fixes one or more open issues, please include the text "Fixes #472" or "Fixes apache/couchdb#472". @@ -265,7 +291,7 @@ git push ``` When merging PRs from forked repositories, we recommend you install the -[hub](https://github.com/github/hub) command line tools. +[hub][#gh_hub] command line tools. This allows you to do: @@ -276,16 +302,31 @@ hub checkout link-to-pull-request meaning that you will automatically check out the branch for the pull request, without needing any other steps like setting git upstreams! :sparkles: - ## Thanks -Special thanks to [Hoodie](https://github.com/hoodiehq/hoodie) for the great +Special thanks to [Hoodie][#gh_hoodie] for the great CONTRIBUTING.md template. -[1]: http://mail-archives.apache.org/mod_mbox/couchdb-user/ -[5]: http://mail-archives.apache.org/mod_mbox/couchdb-dev/ -[6]: http://couchdb.apache.org/conduct.html -[7]: http://couchdb.apache.org/bylaws.html -[8]: http://couchdb.apache.org/#chat - -[#gh_issues]: https://github.com/apache/couchdb/issues \ No newline at end of file +A big thanks to [Robert Painsi][9] and [Bolaji Ayodeji][10] for +some commit message conventions. + +[1]: https://mail-archives.apache.org/mod_mbox/couchdb-user +[5]: https://mail-archives.apache.org/mod_mbox/couchdb-dev +[6]: https://couchdb.apache.org/conduct.html +[7]: https://couchdb.apache.org/bylaws.html +[8]: https://couchdb.apache.org/#chat +[9]: https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53 +[10]: https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide +[11]: mailto:[email protected]?subject=Security +[12]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github +[13]: https://help.github.com/fork-a-repo +[14]: https://github.com/apache/couchdb-documentation +[15]: https://help.github.com/articles/using-pull-requests +[16]: https://help.github.com/articles/about-two-factor-authentication +[17]: https://gitbox.apache.org/setup +[18]: https://help.github.com/articles/interactive-rebase +[19]: https://github.com/apache/couchdb/issues/499 + +[#gh_issues]: https://github.com/apache/couchdb/issues +[#gh_hoodie]: https://github.com/hoodiehq/hoodie +[#gh_hub]: https://hub.github.com \ No newline at end of file
