Thanks for contributing to Forge.
- open an issue or discussion for larger changes
- keep pull requests focused and easy to review
- avoid bundling unrelated refactors with behavior changes
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev,mcp]"Run these before opening a pull request:
ruff check forge_cli/ tests/
pytest tests/ -vForge is designed so code can be public while incident data stays private.
Please do not commit:
- real incident corpora
- internal analysis outputs
- customer data
- regulated personal data
- training/eval source material
- rights, redaction, use-approval, or export manifests copied from Governance
- local
config.local.yamlfiles - machine-specific settings
If you need sample incidents or playbook entries for a change, use sanitized examples only.
- describe the user-facing impact
- call out any schema or CLI contract changes
- add or update tests when behavior changes
- update README or integration docs if setup or usage changes
By submitting a contribution, you agree that your contribution will be licensed under the Apache-2.0 license used by this repository.