Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

25 lines (22 loc) · 1.15 KB
Raw

Contributing

First, thank you for contributing! We love and encourage pull requests from everyone. Please follow the guidelines:

  1. Check open issues and pull requests for existing discussions.

  2. Open an issue first to discuss a new feature or enhancement.

  3. Write tests and make sure the test suite passes locally and on CI.

  4. When optimizing something, write benchmarks and attach the results:

    go test -run - -bench BenchmarkYourFeature -count=10 ./... >old // on master
go test -run - -bench BenchmarkYourFeature -count=10 ./... >new // on your branch
benchstat old new

    benchstat is described here https://godocs.io/golang.org/x/perf/cmd/benchstat.

  5. Open a pull request and reference the relevant issue(s).

  6. Make sure your commits are logically separated and have good comments explaining the details of your change. Add a package/file prefix to your commit if that's applicable (like 'vm: fix ADD miscalculation on full moon').

  7. After receiving a feedback, amend your commits or add new ones as appropriate.

  8. Have fun!