TrueCloudLab/neo-go
6
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-10-16 23:46:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #2058 from nspcc-dev/extend-contributing

Browse source 
CONTRIBUTING.md: add section for benchmarks
This commit is contained in:
Roman Khimov 2021-07-13 10:10:18 +03:00 committed by GitHub
commit a0b062dc18
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -7,6 +7,14 @@ follow the guidelines:
[pull requests](https://github.com/nspcc-dev/neo-go/pulls) for existing discussions. [pull requests](https://github.com/nspcc-dev/neo-go/pulls) for existing discussions.
1. Open an issue first, to discuss a new feature or enhancement. 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. 1. Write tests, and make sure the test suite passes locally and on CI.
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.
1. Open a pull request, and reference the relevant issue(s). 1. Open a pull request, and reference the relevant issue(s).
1. Make sure your commits are logically separated and have good comments 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 explaining the details of your change. Add a package/file prefix to your