diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1e784ea28..dde3d62869 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -379,16 +379,14 @@ Each project must also create and maintain a list of all dependencies and their Follow these guidelines when creating public commits and writing commit messages. -1. If your work spans multiple local commits (for example; if you do safe point commits while working in a feature branch or work in a branch for a long time doing merges/rebases etc.) then please do not commit it all but rewrite the history by squashing the commits into a single big commit which you write a good commit message for (like discussed in the following sections). For more info read this article: [Git Workflow](https://sandofsky.com/workflow/git-workflow/). Every commit should be able to be used in isolation, cherry picked etc. - -2. The first line should be a descriptive sentence what the commit is doing, including the ticket number. It should be possible to fully understand what the commit does—but not necessarily how it does it—by just reading this single line. We follow the "imperative present tense" style for commit messages ([more info here](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)). +1. The first line should be a descriptive sentence what the commit is doing, including the ticket number. It should be possible to fully understand what the commit does—but not necessarily how it does it—by just reading this single line. We follow the "imperative present tense" style for commit messages ([more info here](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)). It is **not ok** to only list the ticket number, type "minor fix" or similar. - If the commit is a small fix, then you are done. If not, go to 3. + If the commit is a small fix, then you are done. If not, go to 2. -3. Following the single line description should be a blank line followed by an enumerated list with the details of the commit. +2. Following the single line description should be a blank line followed by an enumerated list with the details of the commit. -4. You can request a review by a specific team member for your commit (depending on the degree of automation we reach, the list may change over time): +3. You can request a review by a specific team member for your commit (depending on the degree of automation we reach, the list may change over time): * "Review by @gituser "- if you want to notify someone on the team. The others can and are encouraged to participate. Example: