Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 1009 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1009 Bytes
Raw

Contributing to SecretLens

Thanks for helping improve SecretLens.

Development setup

  • Node.js 18+
  • npm
  • Python 3 (for JWT/GCP validators)
git clone https://github.com/Groww-OSS/Secretlens.git
cd Secretlens
npm run install-all
pip3 install -r backend/requirements.txt
cp env.example .env
npm run dev

Branch naming

Use focused branch names:

  • feature/<short-topic>
  • fix/<short-topic>
  • chore/<short-topic>

Commit style

Conventional commits are recommended:

  • feat: add xyz
  • fix: handle abc
  • docs: update readme

Pull request checklist

  • npm run build succeeds
  • No real credentials or .env values were committed
  • If /api/validate was touched, no new shell-execution sinks were introduced
  • Added/updated docs where relevant
  • Followed the "How to add a new validator" guide in README.md when adding validators

Sign-off

By contributing, you agree that your contribution is licensed under the MIT license in this repository.