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

Cassandra Targett edited comment on LUCENE-8842 at 6/7/19 7:05 PM:
-------------------------------------------------------------------

I've added what I had come up with a few months ago to the branch 
{{jira/lucene-8842}} and created a PR for it.

There are three possible locations for the template:

# at the root level of the project ({{lucene-solr/.}}). That's what I've done 
here.
# in a hidden directory {{lucene-solr/.github}}. This does not exist now, but 
if we want to keep the top level cleaner, we could create this directory. If we 
decide to add other GH-centric helpers, this might not be a bad idea.
# in a directory from the root level {{lucene-solr/docs}}. We don't have this 
and don't have need of it, so this is probably not an option.

I mentioned in the PR that I am not sure if the currently commented-out top 
section about how to create Jira issues is visible to users; this may need to 
be changed to some variation of what I have there to be actually visible. PR 
creators would need to remove it when creating PRs, and some would neglect to. 
But maybe that's fine.


was (Author: ctargett):
I've added what I had come up with a few months ago to the branch 
{{jira/lucene-8842}} and created a PR for it.

There are three possible locations for the template:

# at the root level of the project ({{lucene-solr/.}}. That's what I've done 
here.
# in a hidden directory {{lucene-solr/.github}}. This does not exist now, but 
if we want to keep the top level cleaner, we could create this directory. If we 
decide to add other GH-centric helpers, this might not be a bad idea.
# in a directory from the root level {{lucene-solr/docs}}. We don't have this 
and don't have need of it, so this is probably not an option.

I mentioned in the PR that I am not sure if the currently commented-out top 
section about how to create Jira issues is visible to users; this may need to 
be changed to some variation of what I have there to be actually visible. PR 
creators would need to remove it when creating PRs, and some would neglect to. 
But maybe that's fine.

> Add a GitHub Pull Request Template
> ----------------------------------
>
>                 Key: LUCENE-8842
>                 URL: https://issues.apache.org/jira/browse/LUCENE-8842
>             Project: Lucene - Core
>          Issue Type: Task
>          Components: general/tools
>            Reporter: Cassandra Targett
>            Priority: Major
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> GitHub supports having a template for issues and pull requests which can help 
> guide users toward providing important information in their pull requests 
> that will help get their contributions resolved faster.
> From [this dev list 
> thread|https://lists.apache.org/thread.html/f9d6b40a83325d0ac93bc48e98c8c2924e1518d64b92a7ff193ca708@%3Cdev.lucene.apache.org%3E],
>  we'd like to explore creating a template for the lucene-solr project.
> More information about GH PR templates can be found at: 
> https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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

Reply via email to