|
1 | | -## Describe the Change |
| 1 | +# ✅ Pull Request Checklist |
2 | 2 |
|
3 | | -<!-- Add a description of what the pull request is changing, adding, and any other relevant context. --> |
| 3 | +Before submitting your PR for review, please complete this checklist to ensure quality. |
4 | 4 |
|
5 | | -This PR .... |
| 5 | +## Checklist |
6 | 6 |
|
7 | | -## Changed Pages |
| 7 | +- [ ] The **PR description** in the [Describe the Change](#-describe-the-change) section explains what changed and |
| 8 | + provides any additional context. |
| 9 | +- [ ] A **Jira ticket** is provided in the [Jira Tickets](#-jira-tickets) section AND in the PR title. _If this PR has |
| 10 | + no corresponding Jira ticket, then please indicate so in this section._ |
| 11 | +- [ ] **Preview links** are for all affected pages are provided in the [Changed Pages](#-changed-pages). _If this PR |
| 12 | + makes no user-facing changes, please indicate so in this section._ |
| 13 | +- [ ] Conduct a **self-review** for your pages using your preview links. Verify grammar, clarity, and accuracy. |
| 14 | +- [ ] **Check formatting** for your pages |
| 15 | + - [ ] Verify indentations, admonitions, and tables (if applicable). |
| 16 | + - [ ] Verify all images display. |
| 17 | +- [ ] Ensure all **Vale comments** are resolved. |
| 18 | + - [ ] If required, raise a PR to modify the |
| 19 | + [Vale accept list](https://github.com/spectrocloud/spectro-vale-pkg/blob/main/packages/spectrocloud-docs-internal/styles/config/vocabularies/spectrocloud-vocab/accept.txt). |
| 20 | + _This can be done later, but leave a note if required._ |
| 21 | +- [ ] All **CI jobs** have completed successfully. |
| 22 | +- [ ] Add **Backport labels** if the change should be reflected in previous versions. _If required, remember to add the |
| 23 | + `auto-backport` label, as well as the `backport-version-**` labels._ |
| 24 | +- [ ] **Outside review:** Does this PR require review outside of Docs? If yes, tag the appropriate reviewer (for |
| 25 | + example, Engineering, Product, etc.) |
| 26 | +- [ ] Add the `notify-slack` label once this checklist has been completed. The team will be notified and review your PR. |
8 | 27 |
|
9 | | -<!-- Add a link to the preview URL generated by Netlify. Include direct links to the pages affected by the PR. --> |
| 28 | +Good job! 👏👏👏 |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +## 📝 Describe the Change |
10 | 33 |
|
11 | | -💻 [Add Preview URL for Page]() |
| 34 | +<!-- Add a description of what the pull request is changing, adding, and any other relevant context. --> |
12 | 35 |
|
13 | | -## Jira Tickets |
| 36 | +This PR ... |
14 | 37 |
|
15 | | -<!-- Add a link to the JIRA tickets (if applicable) --> |
| 38 | +--- |
| 39 | + |
| 40 | +## 💻 Changed Pages |
| 41 | + |
| 42 | +<!-- Add a link to the preview URL generated by Netlify. Include direct links to the pages affected by the PR. --> |
16 | 43 |
|
17 | | -🎫 [Jira Ticket]() |
| 44 | +- [Add Preview URL for Page]() |
18 | 45 |
|
19 | | -## Backports |
| 46 | +--- |
20 | 47 |
|
21 | | -<!-- Add the relevant backport labels to reflect which versions of the docs your changes will affect. --> |
| 48 | +## 🎫 Jira Tickets |
22 | 49 |
|
23 | | -Can this PR be backported? |
| 50 | +<!-- Add a link to the JIRA tickets (if applicable). --> |
24 | 51 |
|
25 | | -- [ ] Yes. _Remember to add the relevant backport labels to your PR._ |
26 | | -- [ ] No. _Please leave a short comment below about why this PR cannot be backported._ |
| 52 | +[Jira Ticket]() |
0 commit comments