2018-01-31 10:58:28 +00:00
|
|
|
# Contributing
|
|
|
|
|
|
2018-02-02 19:04:56 +00:00
|
|
|
First, thank you for contributing! We love and encourage pull requests from everyone. Please
|
|
|
|
|
follow the guidelines:
|
2018-01-31 10:58:28 +00:00
|
|
|
|
2021-07-23 15:15:43 +00:00
|
|
|
1. Check open [issues](https://github.com/nspcc-dev/neo-go/issues) and
|
2020-03-03 14:21:42 +00:00
|
|
|
[pull requests](https://github.com/nspcc-dev/neo-go/pulls) for existing discussions.
|
2018-02-02 19:04:56 +00:00
|
|
|
1. Open an issue first, to discuss a new feature or enhancement.
|
|
|
|
|
1. Write tests, and make sure the test suite passes locally and on CI.
|
2021-07-12 11:32:56 +00:00
|
|
|
1. 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.
|
|
|
|
|
|
2018-02-02 19:04:56 +00:00
|
|
|
1. Open a pull request, and reference the relevant issue(s).
|
2019-08-20 14:53:52 +00:00
|
|
|
1. 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').
|
|
|
|
|
1. After receiving feedback, amend your commits or add new ones as
|
|
|
|
|
appropriate.
|
|
|
|
|
1. **Have fun!**
|
