|
1 | | -<!-- Make sure the title includes categorization (i.e. [Bug], [QoL], [Localization]) --> |
2 | | -<!-- Make sure that this PR is not overlapping with someone else's work --> |
3 | | -<!-- Please try to keep the PR self-contained (and small) --> |
| 1 | +<!-- (Once you have read these comments, you are free to remove them) --> |
| 2 | +<!-- Feel free to look at other PRs for examples --> |
| 3 | +<!-- |
| 4 | +Make sure the title includes categorization (choose the one that best fits): |
| 5 | +- [Bug]: If the PR is primarily a bug fix |
| 6 | +- [Move]: If a move has new or changed functionality |
| 7 | +- [Ability]: If an ability has new or changed functionality |
| 8 | +- [Item]: For new or modified items |
| 9 | +- [Mystery]: For new or modified Mystery Encounters |
| 10 | +- [Test]: If the PR is primarily adding or modifying tests |
| 11 | +- [UI/UX]: If the PR is changing UI/UX elements |
| 12 | +- [Audio]: If the PR is adding or changing music/sfx |
| 13 | +- [Sprite]: If the PR is adding or changing sprites |
| 14 | +- [Balance]: If the PR is related to game balance |
| 15 | +- [Challenge]: If the PR is adding or modifying challenges |
| 16 | +- [Refactor]: If the PR is primarily rewriting existing code |
| 17 | +- [Docs]: If the PR is just adding or modifying documentation (such as tsdocs/code comments) |
| 18 | +- [GitHub]: For changes to GitHub workflows/templates/etc |
| 19 | +- [Misc]: If no other category fits the PR |
| 20 | +--> |
| 21 | +<!-- |
| 22 | +Make sure that this PR is not overlapping with someone else's work |
| 23 | +Please try to keep the PR self-contained (and small) |
| 24 | +--> |
4 | 25 |
|
5 | 26 | ## What are the changes the user will see? |
6 | 27 | <!-- Summarize what are the changes from a user perspective on the application --> |
7 | 28 |
|
8 | 29 | ## Why am I making these changes? |
9 | | -<!-- Explain why you decided to introduce these changes --> |
10 | | -<!-- Does it come from an issue or another PR? Please link it --> |
11 | | -<!-- Explain why you believe this can enhance user experience --> |
| 30 | +<!-- |
| 31 | +Explain why you decided to introduce these changes |
| 32 | +Does it come from an issue or another PR? Please link it |
| 33 | +Explain why you believe this can enhance user experience |
| 34 | +--> |
| 35 | +<!-- |
| 36 | +If there are existing GitHub issues related to the PR that would be fixed, |
| 37 | +you can add "Fixes #[issue number]" (ie: "Fixes #1234") to link an issue to your PR |
| 38 | +so that it will automatically be closed when the PR is merged. |
| 39 | +--> |
12 | 40 |
|
13 | 41 | ## What are the changes from a developer perspective? |
14 | | -<!-- Explicitly state what are the changes introduced by the PR --> |
15 | | -<!-- You can make use of a comparison between what was the state before and after your PR changes --> |
| 42 | +<!-- |
| 43 | +Explicitly state what are the changes introduced by the PR |
| 44 | +You can make use of a comparison between what was the state before and after your PR changes |
| 45 | +Ex: What files have been changed? What classes/functions/variables/etc have been added or changed? |
| 46 | +--> |
16 | 47 |
|
17 | | -### Screenshots/Videos |
18 | | -<!-- If your change is changing anything on the user experience, please provide visual proofs of it --> |
19 | | -<!-- Please take screenshots/videos before and after your changes, to show what is brought by this PR --> |
| 48 | +## Screenshots/Videos |
| 49 | +<!-- |
| 50 | +If your changes are changing anything on the user experience, please provide visual proofs of it |
| 51 | +Please take screenshots/videos before and after your changes, to show what is brought by this PR |
| 52 | +--> |
20 | 53 |
|
21 | 54 | ## How to test the changes? |
22 | | -<!-- How can a reviewer test your changes once they check out on your branch? --> |
23 | | -<!-- Did you just make use of the `src/overrides.ts` file? --> |
24 | | -<!-- Did you introduce any automated tests? --> |
25 | | -<!-- Do the reviewer need to do something special in order to test your change? --> |
| 55 | +<!-- |
| 56 | +How can a reviewer test your changes once they check out on your branch? |
| 57 | +Did you make use of the `src/overrides.ts` file? |
| 58 | +Did you introduce any automated tests? |
| 59 | +Do the reviewers need to do something special in order to test your changes? |
| 60 | +--> |
26 | 61 |
|
27 | 62 | ## Checklist |
28 | 63 | - [ ] **I'm using `beta` as my base branch** |
29 | 64 | - [ ] There is no overlap with another PR? |
30 | 65 | - [ ] The PR is self-contained and cannot be split into smaller PRs? |
31 | 66 | - [ ] Have I provided a clear explanation of the changes? |
32 | | -- [ ] Have I considered writing automated tests for the issue? |
33 | | -- [ ] If I have text, did I make it translatable and add a key in the English locale file(s)? |
34 | | -- [ ] Have I tested the changes (manually)? |
35 | | - - [ ] Are all unit tests still passing? (`npm run test`) |
36 | | -- [ ] Are the changes visual? |
37 | | - - [ ] Have I provided screenshots/videos of the changes? |
| 67 | +- [ ] Have I tested the changes manually? |
| 68 | +- [ ] Are all unit tests still passing? (`npm run test`) |
| 69 | + - [ ] Have I created new automated tests (`npm run create-test`) or updated existing tests related to the PR's changes? |
| 70 | +- [ ] Have I provided screenshots/videos of the changes (if applicable)? |
| 71 | + - [ ] Have I made sure that any UI change works for both UI themes (default and legacy)? |
| 72 | + |
| 73 | +Are there any localization additions or changes? If so: |
| 74 | +- [ ] Has a locales PR been created on the [locales](https://github.com/pagefaultgames/pokerogue-locales) repo? |
| 75 | + - [ ] If so, please leave a link to it here: |
| 76 | +- [ ] Has the translation team been contacted for proofreading/translation? |
0 commit comments