diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 708a695d90..87ef52cca4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,28 +1,47 @@ -### Summary + +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. -### Other Information +Feel free to discard it if you need to (e.g. when you just fix a typo). --> - -Finally, 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) +This Pull Request has been created because [REPLACE ME] -Thanks for contributing to Rails! --> +### Detail + +This Pull Request changes [REPLACE ME] + +### Additional information + + + +### 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. +* [ ] There are no typos in commit messages and comments. +* [ ] 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]` +* [ ] Feature branch is up-to-date with `main` (if not - rebase it). +* [ ] Pull request only contains one commit for bug fixes and small features. If it's a larger feature, multiple commits are permitted but must be descriptive. +* [ ] Tests are added if you fix a bug or add a feature. +* [ ] 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. +* [ ] PR is not in a draft state. +* [ ] CI is passing. + +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) + +Thanks for contributing to Rails! -->