Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (24 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

30 lines (24 loc) · 1.21 KB
Raw

Contributing to CommitVigil AI 🛡️

First off, thank you for considering contributing to CommitVigil! It's people like you that make CommitVigil a great tool for the community.

🌈 Our Vision

CommitVigil aims to be the standard for high-performance accountability. We value code quality, security, and cultural intelligence.

🛠️ Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Install dependencies using uv: 
    uv sync
  4. Create a new branch for your feature or fix.

📜 Code Standards

We maintain high standards to ensure the "Truth-Gap" engine remains forensic grade:

  • Typing: All code must pass mypy with strict checking.
  • Formatting: We use ruff for linting and formatting.
  • Testing: Ensure all existing tests pass and add new ones for your changes.

🚀 Submitting a Pull Request

  1. Pull the latest changes from main.
  2. Verify your changes locally with pytest.
  3. Push to your fork and submit a Pull Request.
  4. Describe your changes clearly in the PR description.

🛡️ License

By contributing to CommitVigil, you agree that your contributions will be licensed under its MIT License.