Skip to content

Commit

Permalink
docs: add more explanations to developer.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EdieLemoine authored Apr 6, 2023
1 parent b0942e2 commit 3db84b0
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 3db84b0

Please sign in to comment.