Skip to content

Commit fca9e25

Browse files
authored
Merge pull request #2600 from gabrieleluz/issues/2595/1
Fixes #2595 - Clarifies commit message format
2 parents 430616b + 36368bd commit fca9e25

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/pr-coding-guidelines.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,13 @@ All code contributions should come in the form of a pull request, as a topic bra
2626

2727
# OR
2828
# if you are NOT SURE your fork is up-to-date
29-
git pull upstream master
29+
git pull upstream master
3030

3131
# creates new branch
32-
git checkout -b issues/NumberOfIssue/VersionOfPR
32+
git checkout -b issues/NumberOfIssue/VersionOfPR
3333
```
3434

35-
5. Create your patch; commit your changes. Referencing the issue number you're working on from the message is recommended.
36-
37-
> Note: Please keep the title under 50 chars. If you'd like to provide more information, just add the details to the commit body.
35+
5. Create your patch and commit your changes.
3836

3937
```bash
4038
# check for changed files
@@ -44,9 +42,14 @@ All code contributions should come in the form of a pull request, as a topic bra
4442
git add file.js foldername/foldername2/file2.js
4543
4644
# add commit message including issue number
47-
git commit -m 'Issue #NumberOfIssue - Fixes broken layout on mobile browsers'
45+
git commit -m 'Issue #1207 - Fixes broken layout on mobile browsers'
4846
```
4947

48+
Commit messages **must** be written according to the following template:
49+
``Issue #NumberOfIssue - Short message explaining what the commit does``
50+
51+
> Note: Please keep the title under 50 chars. If you'd like to provide more information, just add the details to the commit body.
52+
5053
6. Push your branch to GitHub:
5154
5255
`git push origin issues/NumberOfIssue/VersionOfPR`

0 commit comments

Comments
 (0)