Skip to content

Commit 38b8215

Browse files
authored
Merge pull request #160 from CamilaAlvarez/contributions
docs(contributions): add suggested commit format
2 parents 6309241 + 7880433 commit 38b8215

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,28 @@ Just append `poe check` to your pre-commit file
3333
```shell
3434
echo "poe check" >> .git/hooks/pre-commit
3535
```
36+
37+
### **Suggested commit format**
38+
39+
We recommend following the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#specification), which has the following format:
40+
41+
```shell
42+
<type>[optional scope]: <description>
43+
44+
[optional body]
45+
46+
[optional footer(s)]
47+
```
48+
49+
Types usually are:
50+
51+
1. **fix**: meaning the commit patches a bug in the codebase.
52+
2. **feat**: the commit introduces a new feature to the codebase.
53+
3. **feat!** or **fix!**: the commit introduces a breaking API change.
54+
4. Other types are allowed, for example: **build**, **cli**, **test**, **docs**.
55+
56+
When a commit introduces a breaking change in the API it is recommended to add a **BREAKING CHANGE:** footer.
57+
58+
To provide contextual information an scope may be provided alongside the type. This needs to be contained within parenthesis, for example, `feat(parser): add ability to parse arrays`.
59+
60+
You can find more details on the Conventional Commits specification site.

0 commit comments

Comments
 (0)