Skip to content

Commit 3d7d19c

Browse files
authored
docs: Add conventional commit types to contributing guide (#769)
1 parent 6034c49 commit 3d7d19c

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
@@ -118,6 +118,26 @@ To run the documentation locally (requires Node.js):
118118
uv run poe run-docs
119119
```
120120

121+
## Commits
122+
123+
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.
124+
125+
### Available commit types
126+
127+
| Type | Description |
128+
| ---- | ----------- |
129+
| `feat` | A new feature |
130+
| `fix` | A bug fix |
131+
| `docs` | Documentation only changes |
132+
| `style` | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
133+
| `refactor` | A code change that neither fixes a bug nor adds a feature |
134+
| `perf` | A code change that improves performance |
135+
| `test` | Adding missing tests or correcting existing tests |
136+
| `build` | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
137+
| `ci` | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
138+
| `chore` | Other changes that don't modify src or test files |
139+
| `revert` | Reverts a previous commit |
140+
121141
## Release process
122142

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

0 commit comments

Comments
 (0)