Create PULL_REQUEST_TEMPLATE.md #4
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CodersaurusRex
suggested changes
Sep 15, 2023
Comment on lines
+1
to
+13
| <!-- | ||
| For Work In Progress Pull Requests, please use the Draft PR feature, | ||
| see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. | ||
|
|
||
| For a timely review/response, please avoid force-pushing additional | ||
| commits if your PR already received reviews or comments. | ||
|
|
||
| Before submitting a Pull Request, please ensure you've done the following: | ||
| - 👷♀️ Create small PRs. In most cases this will be possible. | ||
| - ✅ Provide tests for your changes. | ||
| - 📝 Use descriptive commit messages. | ||
| - 📗 Update any related documentation and include any relevant screenshots. | ||
| --> |
There was a problem hiding this comment.
Can we re-think where this goes? I find it a bit cumbersome to move past to get to updating the bit of the template I need to update.
There was a problem hiding this comment.
I would really like to leave this at the top as it only appears while editing.
willl
reviewed
Sep 15, 2023
|
Is the merge type (squash, merge, etc) part of the template? Can we have a section for the PR creator to specifically ask questions? |
Do we really need a specific section for that? If the PR creator wants a discussion, they can add questions, even use the Discussions section for the repository, add comments below etc. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Description
Using Pull Request templates in GitHub can help you write better PRs and make the review process smoother for your team. They provide a standard structure for your PRs and ensure that all necessary information is included.
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
Related Tickets & Documents
Added/updated tests?
[optional] Are there any post Release tasks we need to perform?