Skip to content

Commit 95fcdc3

Browse files
authored
Update pull_request_template.md
1 parent 0c43f16 commit 95fcdc3

File tree

1 file changed

+111
-15
lines changed

1 file changed

+111
-15
lines changed

.github/pull_request_template.md

Lines changed: 111 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,131 @@
1-
## Summary
1+
<!--
2+
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.
3+
-->
4+
5+
## Summary <a href="#user-content-summary" id="summary">#</a>
6+
7+
Provide a summary of your PR. What changed? Explain how you arrived at your solution.
8+
9+
## Accessibility check (Required if applicable) <a href="#user-content-acccessibility" id="acccessibility">#</a>
210

311
<!--
4-
Provide a detailed summary of your PR. What changed? Explain how you arrived at your solution.
12+
Please explain how you've ensured this change is accessible. What steps did you take, what attributes did you take, etc.
13+
-->
514

6-
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.
15+
## Changelog context (Required if changelog included)
16+
17+
If this PR is going into a release and has a changelog entry, we need to have the following context to help understand what has changed and why.
18+
19+
### Why are we making this change? <a href="#user-content-reason" id="reason">#</a>
20+
21+
<!--
22+
Explain why we made this change and how it relates to larger initiatives or requests.
23+
24+
Ex.:
25+
26+
We made this change because our current data visualization and severity colors did not meet 3:1 contrast ratios in light mode.
27+
28+
Related EUI issues or initiatives:
29+
- Closes https://github.com/elastic/eui/issues/8632
30+
- Relates to the High-Contrast mode Beta initiative: https://github.com/elastic/eui/issues/8567
31+
- Part of the Visual Refresh initiative: https://github.com/elastic/eui/issues/8589
32+
33+
Related issues or initiatives from other Elastic products (Kibana, Cloud, etc.):
34+
- Related to a larger initiative in Kibana to create a high-contrast data vis color palette: https://github.com/elastic/kibana/issues/196911
35+
-->
36+
37+
### API Changes <a href="#user-content-api-changes" id="api-changes">#</a>
38+
<!--
39+
What changed in the public API that users should be aware of?
40+
41+
Ex.:
42+
- EuiModal - added 'focusTrapProps' prop
43+
- EuiComboBox -
44+
- EuiLiveAnnouncer - New component (in beta)
45+
- EuiFlyout - new global css variables: --euiPushFlyoutOffsetInlineEnd and --euiPushFlyoutOffsetInlineStart
46+
- Color Tokens - added colors.borderInteractiveFormsHoverPlain
47+
- "This PR has no API changes that users should be aware of"
748
-->
849

9-
## Why are we making this change?
50+
### Functional changes <a href="#user-content-functional-changes" id="functional-changes">#</a>
51+
<!--
52+
What behavior has changed that users should be aware of?
53+
54+
Ex.
55+
- EuiCheckableCard - The click area has expanded for non-interactive children
56+
- EuiInputPopover - Popover now closes on Tab, not Shift+Tab
57+
- "This PR has no functional changes that users should be aware of"
58+
-->
59+
60+
### Visual changes <a href="#user-content-visual-changes" id="visual-changes">#</a>
61+
<!--
62+
What has changed visually that users should be aware of?
1063
64+
Ex.
65+
- EuiDataGrid - Hover colors now darker yellow when stripes={true}
66+
- "This PR has no visual changes that users should be aware of"
67+
68+
-->
69+
70+
### Doc updates ([How to contribute docs](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/documenting)) <a href="#user-content-docs" id="docs">#</a>
1171
<!--
12-
Generally, most PRs should have a related issue from the [public EUI repo](https://github.com/elastic/eui) that explain **why** we are making changes.
72+
Most changes to EUI require updates to docs to reflect the changes. Pick and fill out the most relevant option.
73+
-->
74+
75+
- [ ] Doc updates were made and the production link to them will be here: `{Provide a link}`
76+
- [ ] Docs were updated separately here: `{Provide a link}`
77+
- [ ] This update does not require doc updates, the most relevant existing docs are here: `{Provide a link}`
1378

14-
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.
79+
### [EUI library Figma](https://www.figma.com/community/file/964536385682658129) updates <a href="#user-content-figma" id="figma">#</a>
80+
https://github.com/elastic/platform-ux-team/issues/new?template=design-system-figma.md
81+
<!--
82+
The EUI Figma library must be kept up to date with the JS library. Pick and fill out the most relevant option.
1583
-->
1684

17-
## Screenshots <a href="#user-content-screenshots" id="screenshots">#</a>
85+
- [ ] Updates were already made to Figma, they can be found here: `{Provide a link}`
86+
- [ ] Updates will be made to Figma, a link to the issue to capture that work is here: `{Provide a link}`
87+
- [ ] This behavior does not need to be reflected in Figma. The most relevant Figma file is here: `{Provide a link}`
88+
89+
(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)_
90+
)
1891

92+
### Screenshots <a href="#user-content-screenshots" id="screenshots">#</a>
1993
<!--
20-
If this change includes changes to UI, it is important to include screenshots or gif. This helps our users understand what changed when reviewing our changelogs.
94+
Help us understand at a glance what has changed. "A picture is worth a thousand words".
2195
-->
2296

23-
## Impact to users
97+
### Reproduction instructions <a href="#user-content-reproduce" id="reproduce">#</a>
98+
<!--
99+
How can we reproduce this change?
100+
101+
Examples:
102+
- There is an example in the docs here: https://eui.elastic.co/storybook/index.html?path=/story/navigation-euicollapsiblenav-beta-euicollapsiblenavbeta--playground
103+
- Navigate to this example in docs and chane the "size" field to xs: https://eui.elastic.co/storybook/index.html?path=/story/navigation-euicollapsiblenav-beta-euicollapsiblenavbeta--playground
104+
- There is a story in storybook here: https://eui.elastic.co/storybook/index.html?path=/story/navigation-euicollapsiblenav-beta-euicollapsiblenavbeta--playground
105+
- Create a button and set the size property to "xs". Observe that the text is now larger:
106+
```
107+
<EuiButton size="xs">Example</EuiButton>
108+
```
109+
-->
24110

111+
### Impact <a href="#user-content-impact" id="impact">#</a>
25112
<!--
26-
How will this change impact EUI users? If it's a breaking change, what will they need to do to handle this change when upgrading? Take a moment to look at usage in Kibana and consider how many usages this will impact and note it here.
113+
Pick one of the following options:
114+
-->
115+
116+
- [ ] 🔴 This is a breaking change. I've added the `breaking change` label to this issue and the migration instructions are as follows:
117+
118+
(`<provide migration instructions here>`)
119+
- [ ] 🟡 This change is not technically breaking, but could break tests, affect code that applies custom css, or requies extra testing or attention.
120+
121+
(`<Explain what users should be aware of or what to test>`)
27122

28-
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?
123+
- [ ] 🟢 No impact to existing usage
124+
125+
### Rollout / adoption <a href="#user-content-rollout" id="rollout">#</a>
126+
<!--
127+
- If we're adding a new feature, how are we ensuring it's being adopted in Elastic products? Where is it not being used currently that it should be used?
128+
- If this change requires updates by users, how much change will be required in Elastic products? What is the scope and who's going to make those changes?
29129
-->
30130

31131
## QA
@@ -42,14 +142,10 @@ Remove or strikethrough items that do not apply to your PR.
42142
- [ ] Checked in **Chrome**, **Safari**, **Edge**, and **Firefox**
43143
- [ ] Checked for **accessibility** including keyboard-only and screenreader modes
44144
- Docs site QA
45-
- [ ] Added **[documentation](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/documenting)**
46145
- [ ] 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)**
47146
- [ ] Checked **[Code Sandbox](https://codesandbox.io/)** works for any docs examples
48147
- Code quality checklist
49148
- [ ] Added or updated **[jest](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/testing/unit-testing.md) and [cypress](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/testing/cypress-testing.md) tests**
50149
- [ ] Updated **[visual regression tests](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/testing/visual-regression-testing.md)**
51150
- Release checklist
52151
- [ ] A **[changelog](https://github.com/elastic/eui/blob/main/wiki/contributing-to-eui/documenting/changelogs.md)** entry exists and is marked appropriately.
53-
- [ ] If applicable, added the **breaking change** issue label (and filled out the breaking change checklist)
54-
- Designer checklist
55-
- [ ] 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)_

0 commit comments

Comments
 (0)