random-mirrors
/
pokerogue
mirror of https://github.com/pagefaultgames/pokerogue.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[GitHub] Overhaul GitHub pull request template (#4895) 

Co-authored-by: Adrian T. <68144167+torranx@users.noreply.github.com>
Co-authored-by: Moka <54149968+MokaStitcher@users.noreply.github.com>
This commit is contained in:
NightKev 2024-11-18 17:52:54 -08:00 committed by GitHub
parent b293797c99
commit 6eed6c24c2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 60 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
.github/pull_request_template.md vendored
View File

@ -1,37 +1,76 @@
<!-- Make sure the title includes categorization (i.e. [Bug], [QoL], [Localization]) --> <!-- (Once you have read these comments, you are free to remove them) -->
<!-- Make sure that this PR is not overlapping with someone else's work --> <!-- Feel free to look at other PRs for examples -->
<!-- Please try to keep the PR self-contained (and small) --> <!--
Make sure the title includes categorization (choose the one that best fits):
- [Bug]: If the PR is primarily a bug fix
- [Move]: If a move has new or changed functionality
- [Ability]: If an ability has new or changed functionality
- [Item]: For new or modified items
- [Mystery]: For new or modified Mystery Encounters
- [Test]: If the PR is primarily adding or modifying tests
- [UI/UX]: If the PR is changing UI/UX elements
- [Audio]: If the PR is adding or changing music/sfx
- [Sprite]: If the PR is adding or changing sprites
- [Balance]: If the PR is related to game balance
- [Challenge]: If the PR is adding or modifying challenges
- [Refactor]: If the PR is primarily rewriting existing code
- [Docs]: If the PR is just adding or modifying documentation (such as tsdocs/code comments)
- [GitHub]: For changes to GitHub workflows/templates/etc
- [Misc]: If no other category fits the PR
-->
<!--
Make sure that this PR is not overlapping with someone else's work
Please try to keep the PR self-contained (and small)
-->
## What are the changes the user will see? ## What are the changes the user will see?
<!-- Summarize what are the changes from a user perspective on the application --> <!-- Summarize what are the changes from a user perspective on the application -->
## Why am I making these changes? ## Why am I making these changes?
<!-- Explain why you decided to introduce these changes --> <!--
<!-- Does it come from an issue or another PR? Please link it --> Explain why you decided to introduce these changes
<!-- Explain why you believe this can enhance user experience --> Does it come from an issue or another PR? Please link it
Explain why you believe this can enhance user experience
-->
<!--
If there are existing GitHub issues related to the PR that would be fixed,
you can add "Fixes #[issue number]" (ie: "Fixes #1234") to link an issue to your PR
so that it will automatically be closed when the PR is merged.
-->
## What are the changes from a developer perspective? ## What are the changes from a developer perspective?
<!-- Explicitly state what are the changes introduced by the PR --> <!--
<!-- You can make use of a comparison between what was the state before and after your PR changes --> Explicitly state what are the changes introduced by the PR
You can make use of a comparison between what was the state before and after your PR changes
Ex: What files have been changed? What classes/functions/variables/etc have been added or changed?
-->
### Screenshots/Videos ## Screenshots/Videos
<!-- If your change is changing anything on the user experience, please provide visual proofs of it --> <!--
<!-- Please take screenshots/videos before and after your changes, to show what is brought by this PR --> If your changes are changing anything on the user experience, please provide visual proofs of it
Please take screenshots/videos before and after your changes, to show what is brought by this PR
-->
## How to test the changes? ## How to test the changes?
<!-- How can a reviewer test your changes once they check out on your branch? --> <!--
<!-- Did you just make use of the `src/overrides.ts` file? --> How can a reviewer test your changes once they check out on your branch?
<!-- Did you introduce any automated tests? --> Did you make use of the `src/overrides.ts` file?
<!-- Do the reviewer need to do something special in order to test your change? --> Did you introduce any automated tests?
Do the reviewers need to do something special in order to test your changes?
-->
## Checklist ## Checklist
- [ ] **I'm using `beta` as my base branch** - [ ] **I'm using `beta` as my base branch**
- [ ] There is no overlap with another PR? - [ ] There is no overlap with another PR?
- [ ] The PR is self-contained and cannot be split into smaller PRs? - [ ] The PR is self-contained and cannot be split into smaller PRs?
- [ ] Have I provided a clear explanation of the changes? - [ ] Have I provided a clear explanation of the changes?
- [ ] Have I considered writing automated tests for the issue? - [ ] Have I tested the changes manually?
- [ ] If I have text, did I make it translatable and add a key in the English locale file(s)?
- [ ] Have I tested the changes (manually)?
- [ ] Are all unit tests still passing? (`npm run test`) - [ ] Are all unit tests still passing? (`npm run test`)
- [ ] Are the changes visual? - [ ] Have I created new automated tests (`npm run create-test`) or updated existing tests related to the PR's changes?
- [ ] Have I provided screenshots/videos of the changes? - [ ] Have I provided screenshots/videos of the changes (if applicable)?
- [ ] Have I made sure that any UI change works for both UI themes (default and legacy)?
Are there any localization additions or changes? If so:
- [ ] Has a locales PR been created on the [locales](https://github.com/pagefaultgames/pokerogue-locales) repo?
- [ ] If so, please leave a link to it here:
- [ ] Has the translation team been contacted for proofreading/translation?