Skip to content

docs(contributions): add suggested commit format #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
Merged

docs(contributions): add suggested commit format #160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,28 @@ Just append `poe check` to your pre-commit file
```shell
echo "poe check" >> .git/hooks/pre-commit
```

### **Suggested commit format**

We recommend following the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#specification), which has the following format:

```shell
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

Types usually are:

1. **fix**: meaning the commit patches a bug in the codebase.
2. **feat**: the commit introduces a new feature to the codebase.
3. **feat!** or **fix!**: the commit introduces a breaking API change.
4. Other types are allowed, for example: **build**, **cli**, **test**, **docs**.

When a commit introduces a breaking change in the API it is recommended to add a **BREAKING CHANGE:** footer.

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`.

You can find more details on the Conventional Commits specification site.