Skip to content

Commit 478836b

Browse files
authored
docs: Add author name requirement to PR titles (@fehmer) (monkeytypegame#7089)
1 parent 05e1b82 commit 478836b

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ Below is a set of general guidelines for different types of changes.
2727

2828
### Pull Request Naming Guidelines
2929

30-
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our pull request titles (and commit messages on the master branch). Please follow the guidelines below when naming pull requests.
30+
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our pull request titles (and commit messages on the master branch) and also include the author name at the end inside parenthesis. Please follow the guidelines below when naming pull requests.
31+
3132

3233
For types, we use the following:
3334

@@ -44,6 +45,12 @@ For types, we use the following:
4445
- `revert`: Reverts a previous commit
4546
- `chore`: Other changes that don't apply to any of the above
4647

48+
#### Examples
49+
50+
- `feat: add new feature (@github_username)`
51+
- `impr(quotes): add english quotes (@username)`
52+
- `fix(leaderboard): show user rank correctly (@user1, @user2, @user3)`
53+
4754
### Theme Guidelines
4855

4956
<!-- TODO: add screenshots to provide examples for dos and don'ts -->

0 commit comments

Comments
 (0)