Skip to content

Commit 383cb56

Browse files
authored
docs: Add conventional commit types to contributing guide (#60)
1 parent 9335a11 commit 383cb56

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,26 @@ To run unit tests with HTML coverage report:
8787
uv run poe unit-tests-cov
8888
```
8989

90+
## Commits
91+
92+
We use [Conventional Commits](https://www.conventionalcommits.org/) format for commit messages. This convention is used to automatically determine version bumps during the release process.
93+
94+
### Available commit types
95+
96+
| Type | Description |
97+
| ---- | ----------- |
98+
| `feat` | A new feature |
99+
| `fix` | A bug fix |
100+
| `docs` | Documentation only changes |
101+
| `style` | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
102+
| `refactor` | A code change that neither fixes a bug nor adds a feature |
103+
| `perf` | A code change that improves performance |
104+
| `test` | Adding missing tests or correcting existing tests |
105+
| `build` | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
106+
| `ci` | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
107+
| `chore` | Other changes that don't modify src or test files |
108+
| `revert` | Reverts a previous commit |
109+
90110
## Release process
91111

92112
Publishing new versions to [PyPI](https://pypi.org/project/apify-shared) is automated through GitHub Actions.

0 commit comments

Comments
 (0)