Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (38 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.36 KB
Raw

Contributing to C2-Control-Panel

Thank you for your interest in contributing!

Development Setup

git clone https://github.com/vermarjun/C2-Control-Panel.git
cd C2-Control-Panel
python -m venv venv
source venv/bin/activate        # Linux/macOS
# venv\Scripts\activate         # Windows
pip install -r requirements.txt
cp example.env .env
# Edit .env with your credentials
uvicorn main:app --reload

Branch Strategy

  • main — stable, production-ready code
  • archive/v0 — proof-of-concept gRPC snapshot (read-only)
  • archive/v1 — first full REST API snapshot (read-only)
  • Feature branches: feature/<name> or fix/<name>

Commit Convention

Follow Conventional Commits:

feat: add session kill endpoint
fix: handle missing GeoIP database gracefully
chore: bump sliver-py to 0.0.19
docs: update API reference for listeners

Pull Requests

  1. Fork the repo and create a feature branch off main
  2. Keep PRs focused — one concern per PR
  3. Describe what and why in the PR body
  4. Ensure no secrets, implant binaries, or virtual environments are committed

Security

Never commit:

  • .env files or credentials
  • Generated implants (.exe, .bin, .elf)
  • The venv/ or uploads/ directories

If you discover a security issue, please report it privately rather than opening a public issue.