Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (37 loc) · 977 Bytes

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 977 Bytes
Raw

Contributing to KeyFinder

Thank you for your interest in contributing to KeyFinder!

How to Contribute

Adding New Secret Patterns

  1. Edit js/patterns.js
  2. Add a new pattern object:
{
  name: "Provider Name",
  re: /pattern/g,
  severity: "critical|high|medium|low",
  confidence: "high|medium|low",
  provider: "Provider Name"
}
  1. Test the extension locally

Building for Different Browsers

# Build all browsers
npm run build

# Build specific browser
npm run build:chrome
npm run build:firefox
npm run build:edge
npm run build:safari

Testing

  1. Load unpacked extension in browser
  2. Visit sites with test secrets
  3. Verify detection works correctly

Pull Request Guidelines

  • Follow existing code style
  • Test on all supported browsers
  • Update README if adding new features
  • Keep patterns focused on real secrets

License

By contributing, you agree that your contributions will be licensed under MIT License.