Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.02 KB
Raw

CONTRIBUTING

Any PullRequest for the better is welcome!

  • Branch to PR: main
  • Issues:
    • Please include a simple code snippet to reproduce the issue. It will help us a lot to fix the issue.
    • Issues can be in Japanese and Spanish rather than English if you prefer.

Tests and CIs

You need to pass the below before review.

  • go test -race ./... on Go 1.22 ~ latest
  • golangci-lint run: see the .golangci.yml for the configuration
  • golint ./...
  • Keeping the current code coverage (if possible)

We have CIs to check these. So we recommend to draft PR before you implement something.

For convenience, there is a docker-compose.yml for the above.

# Preparation
docker compose build

# To run test on Go 1.22 which is the min supported version:
docker compose run v1_22

# To run test on latest Go:
docker compose run latest

# To run linters (golangci-lint):
docker compose run lint

# To run vulnerability check:
docker compose run vuln