Skip to content

Commit 25f680e

Browse files
authored
Add more prompts to 8.0 breaking change issue template. (#82184)
1 parent 9f776a2 commit 25f680e

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

.github/ISSUE_TEMPLATE/v8_breaking_change.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ assignees: ''
1313
****************************************
1414
1515
Please add a "NeededFor:${TeamName}" label to denote the team that is
16-
requesting the breaking change is surfaced in the Upgrade Assistant.
16+
requesting the breaking change to be surfaced in the Upgrade Assistant.
1717
1818
-->
1919

@@ -27,21 +27,24 @@ requesting the breaking change is surfaced in the Upgrade Assistant.
2727

2828
**How many users will be affected?**
2929

30-
<!-- e.g., Based on telemetry data, roughly 75% of our users will need to make changes to x -->
31-
<!-- e.g., A majority of users will need to make changes to x. -->
30+
<!-- e.g. Based on telemetry data, roughly 75% of our users will need to make changes to x. -->
31+
<!-- e.g. A majority of users will need to make changes to x. -->
3232

3333
**What can users do to address the change manually?**
3434

35-
<!-- If applicable, describe the manual workaround -->
35+
<!-- If applicable, describe the manual migration steps and/or link to available docs. -->
3636

3737
**How could we make migration easier with the Upgrade Assistant?**
3838

39+
<!-- This can be as basic as notifying the user about the deprecation and linking to some
40+
migration docs, or as advanced as a dedicated UI for fixing the problem. -->
41+
3942
**Are there any edge cases?**
4043

4144
## Test Data
4245

43-
Provide test data. We can’t build a solution without data to test it against.
46+
<!-- Provide test data. We can’t build a solution without data to test it against. -->
4447

4548
## Cross links
4649

47-
Cross-link to relevant [Elasticsearch breaking changes](https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-8.0.html).
50+
<!-- Provide context. Cross-link to relevant [Elasticsearch breaking changes](https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking-changes-8.0.html), PRs that introduced the breaking change, or other related issues. -->

0 commit comments

Comments
 (0)