Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LUCENE-8842: add a pull request template #705

Merged
merged 2 commits into from Jun 13, 2019
Merged

LUCENE-8842: add a pull request template #705

merged 2 commits into from Jun 13, 2019

Conversation

@ctargett
Copy link
Contributor

ctargett commented Jun 7, 2019

This adds a template for pull requests to the top level of the project.

I'm not sure if the commented out section at the top that explains how to create an issue would appear to users, I was never able to find out from other examples I looked at. If it does not, we could modify the template to make some variation of that text appear to users and they could delete it (although it's likely some would not...probably not the end of the world).

@risdenk

This comment has been minimized.

Copy link
Contributor

risdenk commented Jun 7, 2019

I vote for .github instead of in the root, but either way is fine with me.

If you want an example here is the one for Apache Knox: https://raw.githubusercontent.com/apache/knox/master/.github/PULL_REQUEST_TEMPLATE.md

It ends up looking like this:

Screen Shot 2019-06-07 at 3 36 16 PM

I haven't played around with the commented out sections.

@risdenk
risdenk approved these changes Jun 7, 2019
@risdenk

This comment has been minimized.

Copy link
Contributor

risdenk commented Jun 7, 2019

The Elasticsearch one (https://raw.githubusercontent.com/elastic/elasticsearch/master/.github/PULL_REQUEST_TEMPLATE.md) has comments and looks like this:

Editing
Screen Shot 2019-06-07 at 3 41 04 PM

Preview
Screen Shot 2019-06-07 at 3 39 54 PM

@risdenk

This comment has been minimized.

Copy link
Contributor

risdenk commented Jun 7, 2019

So I think what is there is good since it won't be visible when saved, but it is there by default when you open the PR.

@dsmiley

This comment has been minimized.

Copy link
Contributor

dsmiley commented Jun 7, 2019

I also suggest adding to /.github/. Otherwise +1 and thanks!

@janhoy janhoy self-requested a review Jun 13, 2019
@janhoy
janhoy approved these changes Jun 13, 2019
Copy link
Contributor

janhoy left a comment

+1, also prefer this inside a .github folder

@ctargett

This comment has been minimized.

Copy link
Contributor Author

ctargett commented Jun 13, 2019

I added a .github folder and moved the template to it. I'll merge this shortly.

@ctargett ctargett merged commit 719b4c5 into master Jun 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.