Skip to content

Commit 925d916

Browse files
authored
docs: update contributing with commit guidelines
1 parent 3e295ea commit 925d916

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,49 @@ In another terminal window:
5050

5151
## Pull Requests
5252

53-
I welcome your pull requests.
54-
5553
1. Fork the repo and create your branch from `main`.
5654
1. If you've added code that should be tested, add tests.
5755
1. If you've changed the API, update the [README](README) with your changes.
56+
1. Follow the instructions in the PR template
57+
58+
## Commit Messages
59+
60+
Please make sure your commits follow semantic commit messaging.
61+
62+
Format: `<type>(<scope>): <subject>`
63+
64+
`<scope>` is optional
65+
66+
### Example
67+
68+
```
69+
feat: add hat wobble
70+
^--^ ^------------^
71+
| |
72+
| +-> Summary in present tense.
73+
|
74+
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
75+
```
76+
77+
### Types
78+
79+
- `chore`: Updating packages, gulp tasks, etc; no production code change.
80+
- `docs`: Changes to the documentation.
81+
- `feat`: New feature for the user, not a new feature for build script.
82+
- `fix`: Bug fix for the user, not a fix to a build script.
83+
- `refactor`: Refactoring production code, eg. renaming a variable.
84+
- `style`: Formatting, missing semi colons, etc; no production code change.
85+
- `test`: Adding missing tests, refactoring tests; no production code change.
86+
87+
### Usage
88+
89+
- chore: add Oyster build script
90+
- docs: explain hat wobble
91+
- feat: add beta sequence
92+
- fix: remove broken confirmation message
93+
- refactor: share logic between 4d3d3d3 and flarhgunnstow
94+
- style: convert tabs to spaces
95+
- test: ensure Tayne retains clothing
5896

5997
## License
6098

0 commit comments

Comments
 (0)