Contributing¶
Thank you for making the internet safer. Leash Secrets grows stronger with every contribution.
Ways to Contribute¶
1. Add a Secret Pattern (Highest Impact)¶
Found a secret type leash-secrets doesn't detect? This is the most valuable contribution.
2. Reduce False Positives¶
If leash-secrets flags something that isn't a secret, help us fix it:
- Open a false positive report
- Suggest a regex refinement or allowlist rule
- Submit a PR
3. Add Agent Support¶
Want leash-secrets to work with a new AI agent?
- Create the adapter file (rule file, plugin config, etc.)
- Add install instructions to
scripts/install.sh - Update the agent portability docs
- Submit a PR
4. Improve Documentation¶
- Better examples
- Translations
- Stack-specific guides (Django, Rails, Next.js, etc.)
5. Fix Bugs¶
Check open issues for bugs and feature requests.
PR Guidelines¶
- One pattern per PR for pattern additions (fast review)
- Include test cases (redacted real-world examples)
- Use conventional commits:
feat:,fix:,docs:,pattern: - Run validation before submitting
Code of Conduct¶
See Code of Conduct. Be kind, be helpful, be constructive.