Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (35 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 1.12 KB
Raw

Contributing to gomapper

Thanks for your interest in contributing!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/<username>/gomapper.git
  3. Create a branch: git checkout -b my-feature
  4. Make your changes
  5. Run checks: make ci
  6. Push and open a pull request

Development

Prerequisites

  • Go 1.26+
  • golangci-lint v2

Running Tests

make test        # run tests with race detector
make bench       # run benchmarks
make lint        # run linter
make ci          # run all checks

Code Style

  • Follow standard Go conventions
  • Run gofmt and goimports before committing
  • All exported types and functions must have doc comments
  • Keep test coverage high for new code

Pull Requests

  • Keep PRs focused on a single change
  • Include tests for new functionality
  • Update documentation if the public API changes
  • Ensure make ci passes before requesting review

Reporting Issues

  • Use GitHub Issues
  • Include Go version, OS, and a minimal reproduction

License

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