Contributing to RAMPART¶

We welcome contributions and suggestions! Whether you're fixing a bug, adding a new attack type, improving documentation, or filing an issue, your help is appreciated.

Check out our GitHub issues with the "help wanted" and "good first issue" labels for pre-scoped items to contribute.

Getting Started¶

Development Setup

Clone, install, and run the test suite locally.
Code Style & Linting

Ruff, Pyright, pre-commit hooks, and naming conventions.
Testing Standards

Unit vs integration tests, writing tests, coverage expectations.
Architecture for Contributors

Package layout, extension points, and key design decisions.
Extending RAMPART

Step-by-step guides for adding a new attack, probe, evaluator, prompt driver, or attack surface.
Pull Request Process

Fork workflow, commit conventions, CI checks, review expectations.
Release Process

Versioning, changelog, and publishing.

Contributor License Agreement¶

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Code of Conduct¶

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.