chore: Create PR template #1059
Merged
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
added 2 commits
August 24, 2024 11:43
Contributors need some guidance when creating PRs as sometimes crucial information is missing and it isn't clear what is considered "crucial"
melroy89
reviewed
Aug 24, 2024
melroy89
reviewed
Aug 24, 2024
ghost
requested a review
from
melroy89
reviewed
Aug 25, 2024
melroy89
reviewed
Aug 25, 2024
|
I'd like a before | after table for screenshots to be added, like I added manually in #830 for example. This is very helpful and should be mandatory for UI changes imo |
- Add screenshots template to PR template - Remove unnecessary box
is it possible to have two PR templates in GitHUb? Since that could help selecting a template for UI changes specifically. And keep the template more clean for non-UI changes.. |
|
I tried it, but unfortunately with more than one template, one has to know of the template and pass the "template=template name.md" URL parameter.
Fork /~https://github.com/LoveIsGrief/prtemplatetest and try to create a PR to see it.
I'm confident github will improve that flow, just like they did with issue templates, but I don't know when...
|
melroy89
approved these changes
Sep 2, 2024
|
I believe the PR template seems to fulfill all our requirements thus far, without adding too much overhead. I'm fine with merging, if anybody has additional improvements feel free to open a new PR. |
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.
Summary
Adds a default PR template. Its contents will be used for all new PRs.
Checklist
Additional information
Contributors often don't know what kind of information a PR needs. The PR template makes that clear and has comments describing what they are and how to interact with them. A handy checklist is also provided for contributors and reviewers to track what still needs doing.
Related issues
N/A