Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.01 KB
Raw

Contributing to envdiff

Thanks for your interest in contributing!

Development Setup

git clone https://github.com/freedom07/envdiff.git
cd envdiff
go build -o envdiff .
go test ./...

Requires Go 1.21+.

Making Changes

  1. Fork the repo and create a branch from main
  2. Make your changes
  3. Add tests for new functionality
  4. Run go test ./... and ensure all tests pass
  5. Run go vet ./... for static analysis
  6. Open a pull request

Code Style

  • Follow standard Go conventions (gofmt)
  • Keep functions small and focused
  • Add comments for non-obvious logic only

Reporting Bugs

Use the bug report template. Include your envdiff version, OS, and sanitized .env file contents.

Suggesting Features

Use the feature request template.

License

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