Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,11 @@ repos:
language: system
pass_filenames: false
stages: [pre-commit]

#---
- repo: https://github.com/commitizen-tools/commitizen
rev: v4.18.0 # Replace with latest tag
hooks:
- id: commitizen
- id: commitizen-branch
stages: [pre-push]
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on Conventional Commits and the changelog can be updated with Commitizen.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,21 @@ Performance-related PRs should explain:
- what benchmark changed
- why the change is safe

## Commit messages

This project follows the Conventional Commits specification.

Examples:

- `feat: add a new feature`
- `fix(parser): handle invalid input`
- `docs: update documentation`
- `chore: update tooling`

Install the commit message hook with:

```bash
uv run pre-commit install --hook-type commit-msg
---

Happy hacking 🚀
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ dev = [
"pre-commit>=4.5.1",
"httpx>=0.28.1",
"pydantic>=2,<3",
"commitizen>=4.18.0",
]

[tool.black]
Expand All @@ -74,3 +75,8 @@ manifest-path = "rust-base32/Cargo.toml"
module-name = "typeid._base32"
features = ["pyo3/extension-module"]
include = ["LICENSE", "README.md", "typeid/**", "rust-base32/**"]

[tool.commitizen]
name = "cz_conventional_commits"
version_provider = "uv"
update_changelog_on_bump = true
Loading