mirror of
https://github.com/monkeytypegame/monkeytype.git
synced 2025-12-27 10:31:22 +08:00
docs: Add author name requirement to PR titles (@fehmer) (#7089)
This commit is contained in:
parent
05e1b828ae
commit
478836bbf4
1 changed files with 8 additions and 1 deletions
|
|
@ -27,7 +27,8 @@ Below is a set of general guidelines for different types of changes.
|
|||
|
||||
### Pull Request Naming Guidelines
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
For types, we use the following:
|
||||
|
||||
|
|
@ -44,6 +45,12 @@ For types, we use the following:
|
|||
- `revert`: Reverts a previous commit
|
||||
- `chore`: Other changes that don't apply to any of the above
|
||||
|
||||
#### Examples
|
||||
|
||||
- `feat: add new feature (@github_username)`
|
||||
- `impr(quotes): add english quotes (@username)`
|
||||
- `fix(leaderboard): show user rank correctly (@user1, @user2, @user3)`
|
||||
|
||||
### Theme Guidelines
|
||||
|
||||
<!-- TODO: add screenshots to provide examples for dos and don'ts -->
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue