From e1e0f393297d1be6190503fa42ca164c26a54230 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Mon, 9 Feb 2026 13:56:29 +0100 Subject: [PATCH] docs: Add conventional commit types to contributing guide Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 86b6cd9d..927d4a34 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -118,6 +118,26 @@ To run the documentation locally (requires Node.js): uv run poe run-docs ``` +## Commits + +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. + +### Available commit types + +| Type | Description | +| ---- | ----------- | +| `feat` | A new feature | +| `fix` | A bug fix | +| `docs` | Documentation only changes | +| `style` | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | +| `refactor` | A code change that neither fixes a bug nor adds a feature | +| `perf` | A code change that improves performance | +| `test` | Adding missing tests or correcting existing tests | +| `build` | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | +| `ci` | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | +| `chore` | Other changes that don't modify src or test files | +| `revert` | Reverts a previous commit | + ## Release process Publishing new versions to [PyPI](https://pypi.org/project/apify) is automated through GitHub Actions.