Skip to content

Commit 0b777c3

Browse files
committed
Issue #576 README.md added.
1 parent 6fc387d commit 0b777c3

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

quickfixj-perf-test/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,7 @@ $ java -jar target/quickfixj-perf-test.jar -h
4949
#### Guideline for future performance enhancements
5050

5151
1. Check if there is already benchmark available for the code you are planning to optimize.
52-
2. If there is no benchmark code, first create a benchmark and make pull request.
53-
3. Your performance improvement can use the benchmark code as the baseline for comparison.
52+
2. If there is no benchmark code, first create a benchmark (Example `a-missing-perf-regression` branch) and make pull request to `master` branch.
53+
3. Make your performance improvement in a new branch (Example `a-perf-improvement` branch).
54+
4. When you make pull request provide comparison between current benchmark (`master`) and new benchmark values (`a-perf-improvement`)
55+
5. This means providing output of the benchmark execution in two branches in a PR comment

0 commit comments

Comments
 (0)