diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 8e9da9ce..a2f46e7c 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -39,14 +39,18 @@ Most of what is written in the specification is also explained in the following ### Rules -- Use the imperative mood in the subject line. +- Use the imperative mood in the subject line. + - For example: "Fix bug" instead of "Fixed bug" or "Fixes bug". - Do not capitalize the subject line. - Do not end the subject line with a period. -- Use the body to explain the "what" and "why" of the commit, not the "how". +- Use the body to explain the "what" and "why" of the commit, not the "how". + - For example: "This commit fixes a bug" instead of "This commit fixes a bug by changing the code in this way". - If the commit fixes an issue, add "Closes #issue-number" to the body. - In case there are multiple issues, add "Closes #issue-number, Closes #issue-number, ..." to the body. -The header of your commit should be your pull request title, and the body should be your pull request description. +> The header of your commit should be your pull request title, and the body should be your pull request description. + +> See the [correct examples](#correct-examples) and [incorrect examples](#incorrect-examples) for more information. ### Types