Skip to content

Add pull request template #11

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.

Sign up for GitHub

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

Open
manics wants to merge 5 commits into
base: main
Choose a base branch
from
+51 −0
Open

Add pull request template #11

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb3953b
Add pull request template
manics Sep 24, 2020
fc888c5
Include 'List of changes' in 'What does this PR do?'
manics Oct 1, 2020
5fe93de
Apply suggestions from code review
manics Oct 12, 2020
2e010df
Add type of change checkboxes, Move fixes to related section
manics Oct 12, 2020
4899587
Update .github/pull_request_template.md
manics Oct 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!--
Thank you for contributing to this repository!

You can help us review your changes by answering these questions.
They are all optional, but the more information you provide the easier it will be for us to review your changes.
Everyone here is a volunteer, so please help us out if you can.

If you want to discuss anything Jupyter related, or to meet other users and developers, please say hello on https://discourse.jupyter.org/ .
Comment thread
manics marked this conversation as resolved.

@sgibson91 sgibson91 Oct 22, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add in this link as well? https://discourse.jupyter.org/t/introduce-yourself/17/

@manics manics Oct 22, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could do, though since we've got the welcome bot maybe we could add the introduce-yourself link there, perhaps with a stronger emphasis on "say hello", and just have the general link here?

@sgibson91 sgibson91 Oct 22, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this but would actually reverse the suggestion. This is a PR template so folks using it are probably comfortable/familiar enough to make a contribution - we would just like to get to know them better (hence "say hello"). Whereas the bot's job is to orient newcomers who may be more likely to open a support request (hence general link). What do you think?

Also I really am splitting hairs here, so feel free to pass :)

-->


### What does this PR do?
<!--
Please indicate the type of change made by this PR (tick one or more of the boxes) and summarise the PR.
Please also edit the PR title so that it contains enough context to go into a changelog.
Comment thread
sgibson91 marked this conversation as resolved.
It may help to list each change with an explanation of why it's needed- remember that what seems obvious to you may not be obvious to a reviewer.
-->
Type of change:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation
- [ ] Other

### Is this PR related to an issue, or is it part of a larger body of work?
<!--
Please feel free to provide as much context or links to external sites as you want!
Use "Fixes #<NUM>" or "Fixes <URL to GitHub issue>" if this fixes an existing issue.
-->

### Does this PR introduce a breaking change?
<!--
If so what changes might users need to make in their applications due to this PR?
-->

### How can this PR be tested?
<!--
If this is not fully covered by the automated tests please help us by describing the tests that you ran to verify your changes. Make sure to provide as much detail so that we can reproduce your tests.
-->

### What should a reviewer concentrate their feedback on?
<!--
This section is particularly useful if you have a pull request that is still in development.
You can guide the reviews to focus on the parts that are ready for their comments.
You can use bullet points "-" if it helps.
-->

### Other information
<!--
Please provide any other information you think is relevant
-->