Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.12 KB

Contributing Guide

Thank you for your interest in contributing to Leakwatch!

Development Environment

git clone https://github.com/HodeTech/Leakwatch.git
cd Leakwatch
go mod download
go test -race ./...

Requirements

  • Go 1.25+
  • golangci-lint v2+
  • Git 2.30+

Development Workflow

  1. Create a feature branch from main: git checkout -b feature/my-feature
  2. Make your changes
  3. Run tests: go test -race ./...
  4. Run lint checks: golangci-lint run ./...
  5. Create a pull request

Standards

Please review the following standards documents:

Commit Messages

Use Conventional Commits format:

feat(detector): add AWS Secret Access Key detector
fix(engine): fix goroutine leak on worker pool context cancellation
test(entropy): add Shannon entropy edge case tests

License

Your contributions will be licensed under the MIT License.