Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (46 loc) · 1011 Bytes

CONTRIBUTING.md

File metadata and controls

64 lines (46 loc) · 1011 Bytes

Contributing to secr-cli

We welcome contributions from the community. Here's how to help:

Ways to Contribute

Code Improvements

  • Bug fixes
  • Performance optimizations
  • New features

Documentation

  • Improved help texts
  • Better examples
  • Translation

Security Rules

  • New detection patterns
  • Rule improvements
  • False positive reduction

Getting Started

  1. Fork the repository
  2. Create a feature branch
  3. Submit a pull request

Development Setup

git clone https://github.com/your-fork/secr-cli.git
cd secr-cli
go build

Testing

Run the test suite:

make test

Submitting Changes

  1. Ensure tests pass
  2. Update documentation
  3. Keep commits atomic
  4. Write clear commit messages

Code Style

  • Follow standard Go conventions
  • Document exported functions
  • Keep lines under 100 characters
  • Use descriptive variable names

Reporting Issues

Include:

  • Expected behavior
  • Actual behavior
  • Steps to reproduce
  • Environment details