mikemccand commented on code in PR #853: URL: https://github.com/apache/lucene/pull/853#discussion_r861733565
########## CONTRIBUTING.md: ########## @@ -66,6 +66,16 @@ In case your contribution fixes a bug, please create a new test case that fails - *Eclipse* - Basic support ([help/IDEs.txt](https://github.com/apache/lucene/blob/main/help/IDEs.txt#L7)). - *Netbeans* - Not tested. +## Benchmarking + +Use the tool suite at [luceneutil](https://github.com/mikemccand/luceneutil) to benchmark your code changes +if you think that your change may have measurably changed the performance of a task. Review Comment: Maybe add "These are the same benchmarks that run in [nightly benchmarks](https://home.apache.org/~mikemccand/lucenebench/)" or so? ########## CONTRIBUTING.md: ########## @@ -66,6 +66,16 @@ In case your contribution fixes a bug, please create a new test case that fails - *Eclipse* - Basic support ([help/IDEs.txt](https://github.com/apache/lucene/blob/main/help/IDEs.txt#L7)). - *Netbeans* - Not tested. +## Benchmarking + +Use the tool suite at [luceneutil](https://github.com/mikemccand/luceneutil) to benchmark your code changes +if you think that your change may have measurably changed the performance of a task. + +The instructions for running the benchmarks can be found in the luceneutil [README](https://github.com/mikemccand/luceneutil/blob/master/README.md). + +The Lucene community is also interested in other implementations of these benchmark tasks. +Feel free to share your findings (especially if your implementation performs better!) through the [Lucene mailing lists](https://lucene.apache.org/core/discussion.html). Review Comment: Maybe also suggest "...or open an issue or pr in the luceneutil project"? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
