Skip to content

How Can I Engage with the SSVC Community?

We welcome your feedback and contributions to SSVC. Here are some ways you can get involved:

  • Ask a question

    If you have a specific question for the SSVC team, please feel free to Ask a Question.

    Questions of more general interest to the community of SSVC users might fit better in the Q&A section of the Discussion area.

  • Report a problem

    If you find a problem with the SSVC documentation, the methodology, or accompanying code, we welcome your Bug Reports

  • Suggest an improvement

    Got an idea for how to make SSVC better? We'd love to hear it! Please submit your Feature Requests

  • Join the conversation

    More in-depth conversations that might not be actionable as issues are found in the Discussions area.

  • See what we're working on

    We manage the SSVC development effort via Github Issues and Pull Requests. Drop by and see what we're working on, or leave a comment to let us know what you're interested in.

  • Get more involved

    Want more information about engaging as a collaborator? Check out the SSVC Project Wiki

Footer Icons

The icons in the footer of each page also provide links to engage with the SSVC community.

Github Tips for New Contributors

If you are new to contributing to open source projects on Github, we've assembled some pointers to help you get started in the Github Tips for SSVC contributors

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
  1. 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.