[LUCENE-10524] Augment CONTRIBUTING.md guide with instructions on how/when to benchmark

• Type: Wish
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 10.0 (main)
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Gautam Worah
• Created: 19/Apr/22 22:03
• Updated: 28/Aug/22 16:39
• Resolved: 19/Jul/22 21:42

Description

This came up when I was trying to think about improving the experience for new contributors.

Today, new contributors are usually unaware of where luceneutil benchmarks are and when/how to run them. Committers usually end up pointing contributors to the benchmarks package when they make perf impacting changes and then they run the benchmarks.

 

Adding benchmark details to the Lucene repo will also make them more accessible to other researchers who want to experiment/benchmark their own custom task implementation with Java Lucene.

 

What does the community think?

 

Issue Links

• links to: GitHub Pull Request #853