Skip to content

Commit a6c9912

Browse files
committed
wip - docs: specifies commit message format
1 parent 62fd606 commit a6c9912

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Format for Commit Messages
2+
3+
## Goal
4+
5+
## Template
6+
7+
```plaintext
8+
<type>(<optional scope>): <message>
9+
10+
<optional description>
11+
```
12+
13+
## Headers
14+
15+
### Types
16+
17+
Must be one of the following:
18+
19+
| Type | Description | User-facing? | Developer-facing? | In other words... |
20+
|---------------|-----------------------------------------------------------------------------------------------------|--------------------|--------------------|--------------------------------------------------------------|
21+
| `feature` | New functionality | :white_check_mark: | :white_check_mark: | adding a new user story |
22+
| `fix` | Corrections to broken functionality | :white_check_mark: | :white_check_mark: | fixing a bug |
23+
| `preliminary` | New _internal_ functionality | :x: | :white_check_mark: | adding a new utility to be used in the next commit |
24+
| `refactor` | Internal restructuring to existing functionality that unblocks future development | :x: | :white_check_mark: | addressing a code smell |
25+
| `performance` | A refactor that specifically improves speed, efficiency, etc. | :x: | :white_check_mark: | load times, power consumption |
26+
| `types` | A refactor that specifically affects compile-time only, not runtime | :x: | :white_check_mark: | adding a missing type annotation |
27+
| `test` | Affects validation of existing functionality without changing the functionality itself | :x: | :x: | adding a missing unit test, correction an existing unit test |
28+
| `build` | Affects the build system or external dependencies | :x: | :x: | something about npm |
29+
| `ci` | Affects files and scripts that define our CI configuration | :x: | :x: | something about Github Actions/Apps |
30+
| `docs` | Made to "human-executable" files | :x: | :x: | a README update |
31+
| `chore` | Addresses a housekeeping item | :grey_question: | :grey_question: | a dependency update |
32+
| `revert` | Reverses an existing commit | :grey_question: | :grey_question: | |
33+
| `linter` | Affects the files and script that define our lint rules, might also include changes for conformance | :x: | :white_check_mark: | adding an ESLint Rule |
34+
35+
### Scopes
36+
37+
[TODO]
38+
39+
### Summaries
40+
41+
[TODO]
42+
43+
## Bodies
44+
45+
[TODO]
46+
47+
## Footers
48+
49+
[TODO]

0 commit comments

Comments
 (0)