diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3ff52a36d4c..db8675a0434 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,31 +1,139 @@ -## Summary + + +## Summary # + +Provide a summary of your PR. What changed? Explain how you arrived at your solution. + +## Accessibility check (Required if applicable) # -If this is your first PR in the EUI repo, please ensure you've fully read through our [contributing to EUI](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui#how-to-ensure-the-timely-review-of-pull-requests) wiki guide. +## Changelog context (Required if changelog included) + + + +### Why are we making this change? # + + + +### API Changes # + + +### Functional changes # + -## Why are we making this change? +### Visual changes # + +### Doc updates ([How to contribute docs](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/documenting)) # + +- [ ] Doc updates were made and the production link to them will be here: `{Provide a link}` +- [ ] Docs were updated separately here: `{Provide a link}` +- [ ] This update does not require doc updates, the most relevant existing docs are here: `{Provide a link}` -If this change does *not* have an issue associated with, or it is not clear in the issue, please clearly explain *why* we are making this change. This is valuable context for our changelogs. +### [EUI library Figma](https://www.figma.com/community/file/964536385682658129) updates # +https://github.com/elastic/platform-ux-team/issues/new?template=design-system-figma.md + -## Screenshots # +- [ ] Updates were already made to Figma, they can be found here: `{Provide a link}` +- [ ] Updates will be made to Figma, a link to the issue to capture that work is here: `{Provide a link}` +- [ ] This behavior does not need to be reflected in Figma. The most relevant Figma file is here: `{Provide a link}` +(Figma issues can be filed : [here](https://github.com/elastic/platform-ux-team/issues/new/choose) _(This is an internal repo, if you are external to Elastic, ask a maintainer to submit this request)_ + +### Screenshots # -## Impact to users +### Reproduction instructions # + + +### Impact # + +- [ ] 🔴 This is a breaking change. I've added the `breaking change` label to this issue and the migration instructions are as follows: + + (``) + +- [ ] 🟡 This change is not technically breaking, but could break tests, affect code that applies custom css, or requies extra testing or attention. + + (``) + +- [ ] 🟢 No impact to existing usage -Even if it is not a breaking change, how significant is the visual change? Is it a large enough visual change that we would want them advise them to test it? + (``) + +#### Scope of impact in Elastic products: + + +### Rollout / adoption # + ## QA @@ -42,7 +150,6 @@ Remove or strikethrough items that do not apply to your PR. - [ ] Checked in **Chrome**, **Safari**, **Edge**, and **Firefox** - [ ] Checked for **accessibility** including keyboard-only and screenreader modes - Docs site QA - - [ ] Added **[documentation](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/documenting)** - [ ] Props have proper **autodocs** (using `@default` if default values are missing) and **[playground toggles](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/documenting/playgrounds.md)** - [ ] Checked **[Code Sandbox](https://codesandbox.io/)** works for any docs examples - Code quality checklist @@ -50,6 +157,3 @@ Remove or strikethrough items that do not apply to your PR. - [ ] Updated **[visual regression tests](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/testing/visual-regression-testing.md)** - Release checklist - [ ] A **[changelog](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/documenting/changelogs.md)** entry exists and is marked appropriately. - - [ ] If applicable, added the **breaking change** issue label (and filled out the breaking change checklist) -- Designer checklist - - [ ] If applicable, [file an issue](https://github.com/elastic/platform-ux-team/issues/new/choose) to update [EUI's Figma library](https://www.figma.com/community/file/964536385682658129) with any corresponding UI changes. _(This is an internal repo, if you are external to Elastic, ask a maintainer to submit this request)_