Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (55 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 1.68 KB

Contributing

Thanks for helping make PyGuard better. This repo uses tight docs hygiene and fast feedback.

Dev setup

# Clone + env
git clone https://github.com/YOUR_USERNAME/PyGuard.git
cd PyGuard
python -m venv .venv && source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -e ".[dev]"

# Docs tooling
npm i -g markdownlint-cli
pip install vale

Lint & test

# Code
make test
make lint
make format

# Docs
markdownlint "**/*.md"
vale docs/
npx linkinator README.md docs/**/*.md

Running Tests

PyGuard has a comprehensive test suite with 4,701 tests. For detailed testing documentation, see docs/development/TESTING_GUIDE.md.

Quick reference:

# Run all tests
pytest

# Run tests without coverage (faster for development)
pytest --no-cov

# Run tests in parallel (32% faster)
pytest -n auto

# Run only fast tests (skip slow integration tests)
pytest -m "not slow"

# Run specific test file
pytest tests/unit/test_cache.py

Performance: Full suite runs in ~20s (sequential) or ~14s (parallel with -n auto).

Commit style

Conventional commits: feat:, fix:, docs:, chore:, refactor:

Keep PRs narrowly scoped. Include before/after evidence (logs, screenshots).

PR checklist

  • Quickstart works on a clean machine
  • Updated README/config tables as needed
  • Added/updated tests (aim for >70% coverage)
  • Security implications noted (secrets/permissions)
  • Links valid, badges green
  • Docs lint-clean (markdownlint, vale)

Releasing

  • Tag with SemVer (vX.Y.Z)
  • Publish artifacts + SBOM (SPDX)
  • Sign release (Sigstore/cosign)
  • Attach provenance/SLSA