NightOwl888 commented on PR #722:
URL: https://github.com/apache/lucenenet/pull/722#issuecomment-1291433834

   ### Issue Templates
   
   I reported a bug recently to Lucene, and their [bug report 
template](https://raw.githubusercontent.com/apache/lucene/main/.github/ISSUE_TEMPLATE/bug_report.yaml)
 automatically assigns a label to an issue (even though I am not a Lucene 
committer).
   
   I have been meaning to set up issue templates for Lucene.NET at some point, 
especially because bug reports rarely provide the necessary information to 
reproduce the problem.
   
   1. Which target framework?
   2. Which operating system?
   3. Which version of Lucene.NET?
   4. Provide a minimal working example of the code required to reproduce 
(either in a console app or a test). That is - there should be enough code to 
create an index with dummy data and a similar configuration of various 
pluggable components (or their defaults) in order to perform the operation that 
is causing the issue.
   5. What is the observed behavior?
   6. What is the expected behavior?
   
   The dotnet runtime repo has a great [example of what types of things are 
possible](https://github.com/dotnet/runtime/issues/new/choose). Looks like it 
may also be possible to provide external links. So, we could potentially 
redirect people with user questions to either StackOverflow or the user mailing 
list.
   
   That sounds like a new issue that will require some research and discussion 
to do - no need to submit that to this PR.
   
   ### Pull Request Templates
   
   Anyway, after some preliminary research, it turns out that [templates are 
also supported for 
PRs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository)
 and it appears (though not confirmed) that adding a template to produce a PR 
with a specific set of labels is also possible using the [YAML form 
schema](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema).
 The idea is we would create different categories such as "Resolve Issue PR", 
"Draft PR", and "Draft PR with Tests", the latter of which would include a 
label that would fire the tests. Or maybe we could just make a "Draft PR" with 
a form element that allows the user to select to run tests or not, this will 
require some research and experimentation.
   
   > FYI: Do note that we don't have access to the GitHub Settings page, 
however Apache has automated setup of a range of settings through [various 
means](https://cwiki.apache.org/confluence/display/INFRA/Git%2C+GitHub+and+Gitbox),
 most prominently the [.asf.yaml 
file](https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features).
 Of course, if a feature isn't currently supported, it can be discussed with 
INFRA and even contributed by those willing to learn how to do it and navigate 
the obstacles to make the contribution.
   
   However, since issue and PR templates are entirely configured using files in 
the repo, this is something we can set up ourselves - even without being an 
Apache committer.


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to