Skip to content

Commit 9f6b36b

Browse files
authored
docs: add TOC and commits note
1 parent 08084f8 commit 9f6b36b

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

+38
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
Hello and welcome! Here are some notes on how to contribute to this repository.
44

5+
**Contents**
6+
7+
- [Prerequisites](#prerequisites)
8+
- [Files](#files)
9+
- [Parsing files](#parsing-files)
10+
- [Commits](#commits)
11+
512
## Prerequisites
613

714
This repository aims to depend on as little dependencies as possible to make it simple.
@@ -28,3 +35,34 @@ There are two Python scripts that help parse and transform the Markdown informat
2835

2936
1. convert_json.py
3037
2. convert_readme.py
38+
39+
## Commits
40+
41+
We try to adhere to Conventional Commits to make our commit messages more meaningful and semantic when possible. See here for some examples on how to make commit messages https://www.conventionalcommits.org/en/v1.0.0/.
42+
43+
Format: `<type>(<scope>): <subject>`
44+
45+
`<scope>` is optional
46+
47+
**Example:**
48+
49+
```
50+
feat: add hat wobble
51+
^--^ ^------------^
52+
| |
53+
| +-> Summary in present tense.
54+
|
55+
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
56+
```
57+
58+
More Examples:
59+
60+
- `feat`: (new feature for the user, not a new feature for build script)
61+
- `fix`: (bug fix for the user, not a fix to a build script)
62+
- `docs`: (changes to the documentation)
63+
- `style`: (formatting, missing semi colons, etc; no production code change)
64+
- `refactor`: (refactoring production code, eg. renaming a variable)
65+
- `test`: (adding missing tests, refactoring tests; no production code change)
66+
- `chore`: (updating grunt tasks etc; no production code change)
67+
68+
Source: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716

0 commit comments

Comments
 (0)