Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (42 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

68 lines (42 loc) · 1.12 KB
Raw

Contributing Guide

You can contribute to code and help make it better. Apart from bug fixes, features, we particularly value contributions in the form of:

  • Documentation improvements
  • Bug reports

How to contribute

  1. Fork the repository
  2. Add your changes
  3. Submit a pull request

How to report a bug

Create a new issue and add the label "bug".

How to suggest a new feature

Create a new issue and add the label "enhancement".

Development workflow

When contributing changes to repository, follow these steps:

  1. Ensure tests are passing
  2. Ensure you write test cases for new code
  3. Signed-off-by line is required in commit message (use -s flag while committing)

Developer Setup

Requirements

  • Go 1.24.3+

Install Dependencies

  • Install ASDF
  • Install the development tools
asdf plugin add golang
asdf plugin add gitleaks
asdf plugin add golangci-lint
asdf install
  • Install lefthook
go install github.com/evilmartians/lefthook@latest
  • Install git hooks
$(go env GOPATH)/bin/lefthook install

Run Tests

make test