github.com/nspcc-dev/neo-go@v0.105.2-0.20240517133400-6be757af3eba/CONTRIBUTING.md (about) 1 # Contributing 2 3 First, thank you for contributing! We love and encourage pull requests from everyone. Please 4 follow the guidelines: 5 6 1. Check open [issues](https://github.com/nspcc-dev/neo-go/issues) and 7 [pull requests](https://github.com/nspcc-dev/neo-go/pulls) for existing discussions. 8 1. Open an issue first to discuss a new feature or enhancement. 9 1. Write tests and make sure the test suite passes locally and on CI. 10 1. When optimizing something, write benchmarks and attach the results: 11 ``` 12 go test -run - -bench BenchmarkYourFeature -count=10 ./... >old // on master 13 go test -run - -bench BenchmarkYourFeature -count=10 ./... >new // on your branch 14 benchstat old new 15 ``` 16 `benchstat` is described here https://godocs.io/golang.org/x/perf/cmd/benchstat. 17 18 1. Open a pull request and reference the relevant issue(s). 19 1. Make sure your commits are logically separated and have good comments 20 explaining the details of your change. Add a package/file prefix to your 21 commit if that's applicable (like 'vm: fix ADD miscalculation on full 22 moon'). 23 1. After receiving a feedback, amend your commits or add new ones as 24 appropriate. 25 1. **Have fun!**