Skip to content
Merged
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
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing

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

## Setup

You'll need Python 3.10+ and [uv](https://docs.astral.sh/uv/).

```bash
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

```bash
# Run all tests
pytest

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

## Code Style

We use [ruff](https://docs.astral.sh/ruff/) for linting and formatting. The
pre-commit hooks installed above will check your code automatically on commit.
You can also run them manually:

```bash
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](https://github.com/pypa/setuptools-scm) — the version is
derived from git tags automatically.
14 changes: 14 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Security Policy

## Reporting a Vulnerability

If you discover a security vulnerability, please **do not** open a public
issue. Instead, report it privately via
[GitHub's private vulnerability reporting](https://github.com/cpp-linter/cpp-linter-hooks/security/advisories/new).

We'll respond as quickly as possible and keep you updated throughout the
process.

## Supported Versions

Only the latest release receives security patches.
Loading