[ 
https://issues.apache.org/jira/browse/LUCENE-10524?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17524662#comment-17524662
 ] 

Tomoko Uchida commented on LUCENE-10524:
----------------------------------------

I think it is great to have good documentation about benchmarking, actually, it 
is a kind of must-have stuff for this project to me.
I'm not sure how the volume will be, but how about having a dedicated help 
document (say, `gradlew helpBenchmark`) and link to it from CONTRIBUTING.md? 

> Augment CONTRIBUTING.md guide with instructions on how/when to benchmark
> ------------------------------------------------------------------------
>
>                 Key: LUCENE-10524
>                 URL: https://issues.apache.org/jira/browse/LUCENE-10524
>             Project: Lucene - Core
>          Issue Type: Wish
>            Reporter: Gautam Worah
>            Priority: Minor
>
> 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?
>  



--
This message was sent by Atlassian Jira
(v8.20.7#820007)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to