-
Notifications
You must be signed in to change notification settings - Fork 159
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
Update PR template #3153
Update PR template #3153
Conversation
I thought the aim was just to get rid of the
bit? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think putting all this into a comment is the right way to go. Perhaps the checklists should go into a policy (example)?
assignees: '' | ||
|
||
--- | ||
|
||
# Description |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Description |
Is this line necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of having some sort of prompt. I'd really like to have it as a form, but this is not available on github
@ReubenHill it is! See the diff |
But the diff gets rid of all the tickboxes etc too |
I know, but nobody was using them. My original intent was to add this so that essentially anyone could do a code review by following the steps and people who were unsure of what to do could just follow the steps. I still like the idea, but if it's not being used we should probably get rid of it. A lot of PRs just deleted all the text anyway 🤷 |
I used it... |
I know, and so did a couple of other people, but sadly you were in a minority. What I'd really like is a bunch of PR templates that you could select from like you can with issue templates, but it seems like this feature hasn't landed in github's interface yet. I have set up a folder with other templates for when they do enable it though! |
.github/pull_request_template.md
Outdated
- [ ] No CI issues (excessive parallelism/memory usage/time/warnings generated) | ||
- [ ] Upstream/dependent branches and PRs are ready | ||
If issues are fixed by this PR, include link to them and prepend each of them with the word "fixes", so they are automatically closed when this PR is merged. | ||
For example "fixes #123, fixes #456".. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This (because no-one deletes the text) links every PR for all eternity to these two issues. fixes #xyz
?
* Update PR template --------- Co-authored-by: David A. Ham <david.ham@imperial.ac.uk>
* Update PR template --------- Co-authored-by: David A. Ham <david.ham@imperial.ac.uk>
* Update PR template --------- Co-authored-by: David A. Ham <david.ham@imperial.ac.uk>
So that it no longer looks like this: