-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update pull request template (#4599)
* Update pull request template * Update pull request template * Update pull request template * Update pull request template * Update pull request template
- Loading branch information
1 parent
e610ca5
commit f768b2f
Showing
2 changed files
with
65 additions
and
55 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "saleor-dashboard": patch | ||
| --- | ||
|
|
||
| Update pull request template |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,60 @@ | ||
| closes #... | ||
|
|
||
| ### Screenshots | ||
|
|
||
| <!-- If your changes affect the UI, providing "before" and "after" screenshots will | ||
| greatly reduce the amount of work needed to review your work. --> | ||
|
|
||
| ### Pull Request Checklist | ||
|
|
||
| <!-- Please keep this section. It will make maintainer's life easier. --> | ||
|
|
||
| 1. [ ] This code contains UI changes | ||
| 2. [ ] All visible strings are translated with proper context including data-formatting | ||
| 3. [ ] Attributes `data-test-id` are added for new elements | ||
| 4. [ ] The changes are tested in Chrome/Firefox/Safari browsers and in light/dark mode | ||
| 5. [ ] Your code works with the latest stable version of the core | ||
| 6. [ ] I added changesets file (instructions in [contribution guide](https://github.com/saleor/saleor-dashboard/blob/main/.github/CONTRIBUTING.md) | ||
|
|
||
| ### Test environment config | ||
|
|
||
| <!-- Do not remove this section. It is required to properly setup test deployment instance. | ||
| Modify API_URI if you want test instance to use custom backend. CYPRESS_API_URI is optional, use when necessary. --> | ||
|
|
||
| API_URI=https://automation-dashboard.staging.saleor.cloud/graphql/ | ||
| APPS_MARKETPLACE_API_URI=https://apps.staging.saleor.io/api/v2/saleor-apps | ||
|
|
||
| ### Do you want to run more stable tests? | ||
|
|
||
| To run all tests, just select the stable checkbox. To speed up tests, increase the number of containers. Tests will be re-run only when the "run e2e" label is added. | ||
|
|
||
| 1. [ ] stable | ||
| 2. [ ] app | ||
| 3. [ ] attribute | ||
| 4. [ ] category | ||
| 5. [ ] collection | ||
| 6. [ ] customer | ||
| 7. [ ] giftCard | ||
| 8. [ ] homePage | ||
| 9. [ ] login | ||
| 10. [ ] menuNavigation | ||
| 11. [ ] navigation | ||
| 12. [ ] orders | ||
| 13. [ ] pages | ||
| 14. [ ] payments | ||
| 15. [ ] permissions | ||
| 16. [ ] plugins | ||
| 17. [ ] productType | ||
| 18. [ ] products | ||
| 19. [ ] sales | ||
| 20. [ ] shipping | ||
| 21. [ ] translations | ||
| 22. [ ] variants | ||
| 23. [ ] vouchers | ||
|
|
||
| CONTAINERS=2 | ||
| <!-- | ||
| First of all, thank your for the contribution! We appreciate all incoming pull requests! 🥳 | ||
| Before submitting your pull request, please ensure you've done the following: | ||
| 📖 Read contribution guide: https://github.com/saleor/saleor-dashboard/blob/main/.github/CONTRIBUTING.md | ||
| 🤓 Your pull request is small enough (otherwise please create smaller chunks) | ||
| 👀 You have added proper test coverage | ||
| 👜 The pull request's title is readable and meaningful | ||
| 📜 You have added changeset file | ||
| 📄 If you add/update some copy, they are extracted: run npm run extract-messages | ||
| 🧵 NOTE: Tests. | ||
| Tests are MANDATORY, please follow these scenarios: | ||
| 👉🏼 when you are fixing a bug, test should cover regression you fix | ||
| 👉🏼 when you develop new feature, test should cover at least user stories steps (it can be tested by rendering component that implements given feature) | ||
| 👉🏼 Please do not implement e2e tests by yourself, we try to limit them for the favor of integration (RTL) ones or units. | ||
| 🧵 NOTE: Changesets. | ||
| Each pull request requires changeset file, that you can add by running command: npm run change:add. The prompt will ask you to pick a type of change: | ||
| 👉🏼 patch - any fix, typo change, CI change, tiny visuals, basically any change that can be seamlessly portable to previous releases | ||
| 👉🏼 minor - new features, ui changes, everything that will be includes in the upcoming minor release. | ||
| --> | ||
|
|
||
| ## What type of PR is this? | ||
| - [ ] 💅 Refactor | ||
| - [ ] 🌟 Feature | ||
| - [ ] 🔥 Bug Fix | ||
| - [ ] 🔩 Maintenance | ||
| - [ ] 🛠 Workflow CI/CD changes | ||
|
|
||
| ## Related Issues or Documents | ||
| <!-- | ||
| 🔑 In this section please attach any resources that are related | ||
| such as: other issues, other pull requests, docs link etc. | ||
| If your pull request is closing some issue, use the close clause: | ||
| closes #123 - github will automatically link related by by its number | ||
| --> | ||
|
|
||
| - closes # | ||
|
|
||
| ## Usage Instructions, Screenshots, Recordings | ||
| <!-- | ||
| 🔑 Attach here anything that is needed for maintainers: | ||
| - if it's a bug, attach steps to reproduce (unless they are already attached with linked issue) | ||
| - any instructions of usage | ||
| - screenshots or videos if applicable | ||
| --> | ||
|
|
||
| ## Have you written tests? | ||
| - [ ] Yes! | ||
| - [ ] No... here is why: _Writing tests are mandatory, please replace this text with why test are not included in this PR_ | ||
|
|
||
|
|
||
| ## [Optional] Description | ||
| <!-- | ||
| 🔑 Put here any additional information regarding change you make. Any additional context, description of what was done. | ||
| --> |