Skip to content

Commit c8c7168

Browse files
committed
Update commit message guidelines.
1 parent 7edca7a commit c8c7168

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,17 @@ To suggest a new feature or other improvement, create an issue on GitHub and cho
3535

3636
## Code Guidelines
3737

38-
<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->
39-
4038
### NGINX Code Guidelines
4139

4240
Before diving into the NGINX codebase or contributing, it's important to understand the fundamental principles and techniques outlined in the [NGINX Development Guide] (http://nginx.org/en/docs/dev/development_guide.html).
4341

4442
### Git Guidelines
4543

4644
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
47-
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated
48-
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
45+
- Follow below guidelines for writing commit messages:
4946
- In the subject line, use the present tense ("Add feature" not "Added feature").
5047
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
48+
- End subject line with a period.
5149
- Limit the subject line to 72 characters or less.
52-
- Reference issues and pull requests liberally after the subject line.
50+
- Reference issues in the subject line and/or body.
5351
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

0 commit comments

Comments
 (0)