38 lines (30 loc) · 1.3 KB

Contributing to Prometheus

Thank you for your interest in contributing to Prometheus!

Code of Conduct & Scope Safety

Prometheus is an authorized CTF competition, cybersecurity lab, and research toolkit.

Non-Destructive Focus: Contributions must remain strictly non-destructive. Do not add automated exploitation, payload delivery, malware functionality, credential theft, DDoS, or stealth/evasion mechanisms.
Evidence-Based Findings: Triage findings must require factual evidence. Never flag a vulnerability based solely on port existence or version disclosures.

Development Workflow

Clone the repository and navigate to the project directory:

git clone https://github.com/Prometheus-CTF/Prometheus.git
cd Prometheus

Set up a virtual environment and install development dependencies:

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Run the test suite:
```
pytest tests/ -v
```
Run formatting and linting:
```
ruff check .
```

Pull Request Guidelines

Add unit tests under tests/ for all new features or bug fixes.
Ensure all tests pass deterministic execution offline without making live internet requests.
Verify no secrets, credentials, tokens, or generated scan logs are committed.