TrueCloudLab/neo-go
8
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-11-22 09:29:38 +00:00
Code Issues Projects Releases Packages Wiki Activity
neo-go/CONTRIBUTING.md
Evgeniy Stratonikov c32e63239e CONTRIBUTING.md: add section for benchmarks 
Signed-off-by: Evgeniy Stratonikov <evgeniy@nspcc.ru>
2021-07-12 14:34:38 +03:00

1.1 KiB
Raw Blame History

Contributing

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

  1. Check the 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 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 feedback, amend your commits or add new ones as appropriate.

  8. Have fun!