TEST_CODEOWNERS/rails
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
b4344c86ad
rails/.github/pull_request_template.md

48 lines
2.0 KiB
Markdown
Raw Normal View History

Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
<!--
Make PR template less onerous I think no one is reading this because I've seen an increase in draft PRs. To fix that I've moved the draft statement to the top. I also think the number of check boxes is a lot and isn't resulting in better PRs because the length means they are not being read. I removed ones that I think are repetitive or unhelpful. I wish I could A/B test this...
2022-10-19 14:25:25 +00:00
Thanks for contributing to Rails!
Please do not make *Draft* pull requests, as they still send
notifications to everyone watching the Rails repo.
Create a pull request when it is ready for review and feedback
from the Rails team :).
If your pull request affects documentation or any non-code
changes, guidelines for those changes are [available
here](https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation)
Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
About this template
Add `issue_template.md` and `pull_request_template.md` This appears to be a new feature of GitHub. See these links for more details: - https://github.com/dear-github/dear-github/issues/125 - https://github.com/owncloud/core/issues/new - https://github.com/blog/2111-issue-and-pull-request-templates [ci skip]
2016-02-17 17:48:46 +00:00
Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
The following template aims to help contributors write a good description for their pull requests.
We'd like you to provide a description of the changes in your pull request (i.e. bugs fixed or features added), motivation behind the changes, and complete the checklist below before opening a pull request.
Add `issue_template.md` and `pull_request_template.md` This appears to be a new feature of GitHub. See these links for more details: - https://github.com/dear-github/dear-github/issues/125 - https://github.com/owncloud/core/issues/new - https://github.com/blog/2111-issue-and-pull-request-templates [ci skip]
2016-02-17 17:48:46 +00:00
Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
Feel free to discard it if you need to (e.g. when you just fix a typo). -->
Add `issue_template.md` and `pull_request_template.md` This appears to be a new feature of GitHub. See these links for more details: - https://github.com/dear-github/dear-github/issues/125 - https://github.com/owncloud/core/issues/new - https://github.com/blog/2111-issue-and-pull-request-templates [ci skip]
2016-02-17 17:48:46 +00:00
Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
### Motivation / Background
Add `issue_template.md` and `pull_request_template.md` This appears to be a new feature of GitHub. See these links for more details: - https://github.com/dear-github/dear-github/issues/125 - https://github.com/owncloud/core/issues/new - https://github.com/blog/2111-issue-and-pull-request-templates [ci skip]
2016-02-17 17:48:46 +00:00
PR template: note about auto-closing issue I've noticed a few PRs made since the latest template update, that have said things like "this PR was created because of #ISSUE" or things along those lines. It seems like people are reading the template and following its advice! But Github requires a specific syntax to auto-close an issue, so we may as well encourage people to use that to save everyone a bit of time. So in this PR I've added a comment to the template explaining that.
2022-10-22 14:23:29 +00:00
<!--
Describe why this Pull Request needs to be merged. What bug have you fixed? What feature have you added? Why is it important?
If you are fixing a specific issue, include "Fixes #ISSUE" (replace with the issue number, remove the quotes) and the issue will be linked to to this PR.
-->
Add a note about adding CHANGELOG entries at the top of the file [ci skip]
2016-07-02 14:45:41 +00:00
Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
This Pull Request has been created because [REPLACE ME]
Add `issue_template.md` and `pull_request_template.md` This appears to be a new feature of GitHub. See these links for more details: - https://github.com/dear-github/dear-github/issues/125 - https://github.com/owncloud/core/issues/new - https://github.com/blog/2111-issue-and-pull-request-templates [ci skip]
2016-02-17 17:48:46 +00:00
Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
### Detail
This Pull Request changes [REPLACE ME]
### Additional information
<!-- Provide additional information such as benchmarks, reference to other repositories or alternative solutions. -->
### Checklist
Before submitting the PR make sure the following are checked:
* [ ] This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
* [ ] Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: `[Fix #issue-number]`
Make PR template less onerous I think no one is reading this because I've seen an increase in draft PRs. To fix that I've moved the draft statement to the top. I also think the number of check boxes is a lot and isn't resulting in better PRs because the length means they are not being read. I removed ones that I think are repetitive or unhelpful. I wish I could A/B test this...
2022-10-19 14:25:25 +00:00
* [ ] Tests are added or updated if you fix a bug or add a feature.
Update Pull Request Template The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
2022-06-30 14:08:37 +00:00
* [ ] CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.
* [ ] CI is passing.
Warning about draft PRs
2021-09-27 20:03:29 +00:00
Reference in New Issue Copy Permalink