Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (36 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 1.08 KB

Contributing

Thanks for your interest in contributing to cpp-linter-hooks!

Setup

You'll need Python 3.10+ and uv.

git clone https://github.com/cpp-linter/cpp-linter-hooks.git
cd cpp-linter-hooks
uv sync
source .venv/bin/activate
pre-commit install

Running Tests

# Run all tests
pytest

# With coverage
coverage run -m pytest && coverage report

Code Style

We use ruff for linting and formatting. The pre-commit hooks installed above will check your code automatically on commit. You can also run them manually:

pre-commit run --all-files

Making Changes

  1. Create a branch from main
  2. Make your changes and add tests
  3. Run pytest to make sure everything passes
  4. Open a pull request against main

PRs should have a clear description of what changed and why. Reference any related issues.

Release Process

Releases are tagged by maintainers. Versioning follows setuptools-scm — the version is derived from git tags automatically.