Skip to content

Commit 74c9ec7

Browse files
committed
Add notes on benchmarking to README
1 parent 9799f23 commit 74c9ec7

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,18 @@ If you'd like to contribute code, please [create a pull request](https://github.
7878

7979
__Note:__ If you are considering working on BitByteData, please note that Xcode project (BitByteData.xcodeproj)
8080
was created manually and you shouldn't use `swift package generate-xcodeproj` command.
81+
82+
### Performance and benchmarks
83+
84+
One of the most important goals of BitByteData's development is high speed performance. To help achieve this goal there
85+
are benchmarks for every function in the project as well as a handy command-line tool, `benchmarks.py`, which helps to
86+
run, show, and compare benchmarks and their results.
87+
88+
If you are considering contributing to the project please make sure that:
89+
90+
1. Every new function has also a new benchmark added.
91+
2. Every other change to any existing function doesn't introduce performance regressions, or, at the very least, these
92+
regressions are small and such performance tradeoff is necessary and justifiable.
93+
94+
Finally, please note that any meaningful comparison can be made only between benchmarks run on the same hardware and
95+
software system.

0 commit comments

Comments
 (0)