Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (40 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.79 KB
Raw

How to contribute

Thanks for your help on improving our stakeholder-specific vulnerability categorization work. To account for different stakeholder perspectives, we benefit from a diverse group of contributors.

Please see our project documentation in the wiki that accompanies this repository for more information on how you can contribute to the project.

Development Setup

Prerequisites

  • Python 3.12+
  • uv - Fast Python package installer and resolver
  • pre-commit - Git hooks framework

Installing Dependencies and Git Hooks

  1. Set up the development environment:

    make dev

  2. Install pre-commit hooks:

    uv run pre-commit install

Pre-Commit Hooks

This repository uses pre-commit to enforce code quality standards before commits. The following hooks are configured:

Hook Scope Behavior
Black Python files Auto-formats code; blocks commit if changes made
Markdownlint Markdown files Auto-fixes linting issues; blocks commit if changes made
Doctools Decision point/table Python files Regenerates JSON files; blocks commit if changes made (review before staging)
Pytest All tests Runs full test suite; non-blocking (warning only)

Running hooks manually:

uv run pre-commit run --all-files

Skipping hooks (use sparingly):

git commit --no-verify

Licenses

See LICENSE

Questions

If you have any questions, an issue or discussion is the best way to get in touch with us.