Contributing
Contributing guide for PromptShield.
Three repos:
- Dashboard (TypeScript/Bun): promptshieldhq/promptshield
- Proxy (Go): promptshieldhq/promptshield-proxy
- Engine (Python): promptshieldhq/promptshield-engine
Before opening a PR
If it's a bug fix, a failing test or reproduction steps help. If it's a new feature or a non-trivial change, open an issue first — saves building something in the wrong direction.
Fork, branch off main, keep the PR focused on one thing.
Running locally
Dashboard:
git clone https://github.com/promptshieldhq/promptshield
cd promptshield
cp .env.local.example .env.local # fill in BETTER_AUTH_SECRET
docker compose -f docker-compose.dev.yml up --buildProxy:
git clone https://github.com/promptshieldhq/promptshield-proxy
cd promptshield-proxy
cp .env.example .env
docker compose -f docker-compose.dev.yml up --buildEngine:
git clone https://github.com/promptshieldhq/promptshield-engine
cd promptshield-engine
docker compose -f docker-compose.dev.yml up --buildCommits
fix: block action not applied when entity type is masked
feat: add IBAN detection to engine
docs: add troubleshooting guideQuestions
For bugs or issues, open an issue in the relevant repo.
For discussions or questions, open a GitHub Discussion.