.github/ISSUE_TEMPLATE: refine language in all templates
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
@@ -29,7 +29,7 @@ body:
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: '🗃️ Project Area'
|
||||
description: What project area is this issue closest related to? This will help find an owner for the issue faster.
|
||||
description: Which project area is this issue most closely related to? This will help find an owner for the issue faster.
|
||||
options:
|
||||
- Unknown
|
||||
- Auditor
|
||||
@@ -80,7 +80,7 @@ body:
|
||||
- id: willing-to-submit-pr
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: Are you willing to submit PR?
|
||||
label: Are you willing to submit a PR?
|
||||
description: This is absolutely not required, but we are happy to guide you in the contribution process.
|
||||
options:
|
||||
- Undecided
|
||||
|
||||
@@ -8,7 +8,7 @@ body:
|
||||
attributes:
|
||||
value: |
|
||||
Please fill in each section completely, and [search in GitHub](https://github.com/backstage/backstage/search?type=Issues)
|
||||
before reporting a new bug in order to avoid duplicates. Thank you!
|
||||
before reporting a new bug to avoid duplicates. Thank you!
|
||||
# This field is managed by .common.yaml
|
||||
- id: issue-labels
|
||||
type: checkboxes
|
||||
@@ -45,7 +45,7 @@ body:
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: '🗃️ Project Area'
|
||||
description: What project area is this issue closest related to? This will help find an owner for the issue faster.
|
||||
description: Which project area is this issue most closely related to? This will help find an owner for the issue faster.
|
||||
options:
|
||||
- Unknown
|
||||
- Auditor
|
||||
@@ -94,9 +94,9 @@ body:
|
||||
attributes:
|
||||
label: '📝 Description & Context'
|
||||
placeholder: |
|
||||
Describe the observed behavior that you deem to be incorrect, as well as any additional context that might be useful in understanding the bug.
|
||||
Describe the observed behavior that you believe to be incorrect, as well as any additional context that might be useful in understanding the bug.
|
||||
|
||||
e.g. "When i navigate to the catalog index page it loads without a hitch. May be related to https://xkcd.com/1172"
|
||||
e.g. "When I navigate to the catalog index page, it loads without any issues. This might be related to https://xkcd.com/1172"
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
validations:
|
||||
@@ -117,9 +117,9 @@ body:
|
||||
|
||||
Being able to easily reproduce the bug will significantly increase the likelihood that it can be identified and fixed. Please provide a repository where the bug can be reproduced, unless this is a critical bug that needs immediate attention.
|
||||
|
||||
If you are unable to provide a reproduction repo, please explain the reproduction steps in as much detail as possible, and include the output of `yarn backstage-cli info` if relevant.
|
||||
If you are unable to provide a reproduction repository, please explain the reproduction steps in as much detail as possible, and include the output of `yarn backstage-cli info` if relevant.
|
||||
|
||||
If inadequate or no reproduction steps are provided, the bug report is likely to be labelled as needing reproduction steps before it can be progressed further.
|
||||
If inadequate or no reproduction steps are provided, the bug report is likely to be labeled as needing reproduction steps before it can be progressed further.
|
||||
- type: input
|
||||
id: reproduction-repo
|
||||
attributes:
|
||||
|
||||
@@ -10,7 +10,7 @@ body:
|
||||
value: |
|
||||
This template is used to report issues in the Backstage documentation.
|
||||
|
||||
The documentation at [backstage.io](https://backstage.io) is only updated when a new release is made. Before reporting an issue here, please check that the issue also exists in the ["next"](https://backstage.io/docs/next/overview/what-is-backstage) version of the documentation, which you can switch to in the top-right dropdown menu.
|
||||
The documentation at [backstage.io](https://backstage.io) is only updated when a new release is made. Before reporting an issue here, please verify that the issue also exists in the ["next"](https://backstage.io/docs/next/overview/what-is-backstage) version of the documentation, which you can access using the top-right dropdown menu.
|
||||
# This field is managed by .common.yaml
|
||||
- id: issue-labels
|
||||
type: checkboxes
|
||||
@@ -24,7 +24,7 @@ body:
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: '🗃️ Project Area'
|
||||
description: What project area is this issue closest related to? This will help find an owner for the issue faster.
|
||||
description: Which project area is this issue most closely related to? This will help find an owner for the issue faster.
|
||||
options:
|
||||
- Unknown
|
||||
- Auditor
|
||||
@@ -72,9 +72,9 @@ body:
|
||||
required: true
|
||||
attributes:
|
||||
label: '📝 Description'
|
||||
description: Describe the problem you have found in the docs.
|
||||
description: Describe the problem you have found in the documentation.
|
||||
placeholder: |
|
||||
Please provide links to the specific pages and sections that need to be corrected and describe the problem you have found.
|
||||
Please provide links to the specific pages and sections that need to be corrected, and describe the problem you have found.
|
||||
# This field is managed by .common.yaml
|
||||
- id: read-code-of-conduct
|
||||
type: checkboxes
|
||||
|
||||
@@ -7,7 +7,7 @@ body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This template lets you highlight maintenance tasks that need special consideration, such as tricky version bumps or migrations.
|
||||
This template helps you track maintenance tasks that require special consideration, such as complex version updates or migrations.
|
||||
# This field is managed by .common.yaml
|
||||
- id: issue-labels
|
||||
type: checkboxes
|
||||
@@ -35,7 +35,7 @@ body:
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: '🗃️ Project Area'
|
||||
description: What project area is this issue closest related to? This will help find an owner for the issue faster.
|
||||
description: Which project area is this issue most closely related to? This will help find an owner for the issue faster.
|
||||
options:
|
||||
- Unknown
|
||||
- Auditor
|
||||
@@ -64,7 +64,7 @@ body:
|
||||
label: '🛠️ Task'
|
||||
description: Describe the task that requires attention
|
||||
placeholder: |
|
||||
Explain what needs to be accomplished as well as any context for the change such as dependencies.
|
||||
Explain what needs to be accomplished, including any relevant context such as dependencies or related components.
|
||||
- type: textarea
|
||||
id: proposal
|
||||
validations:
|
||||
@@ -73,9 +73,9 @@ body:
|
||||
label: '📊 Priority & Impact'
|
||||
description: Explain the urgency and impact of this task
|
||||
placeholder: |
|
||||
Explain what level of prioritization this task should receive. Are there any particular benefits provided in newer versions in case of a version bump, or any security vulnerabilities that can be removed?
|
||||
Explain what level of prioritization this task should receive. Are there any particular benefits provided in newer versions in case of a version update, or any security vulnerabilities that can be addressed?
|
||||
|
||||
Also list any important dates or deadlines, which as current versions reaching end of life, or release dates for stable releases.
|
||||
Also list any important dates or deadlines, such as current versions reaching end of life, or release dates for stable releases.
|
||||
# This field is managed by .common.yaml
|
||||
- id: read-code-of-conduct
|
||||
type: checkboxes
|
||||
@@ -88,7 +88,7 @@ body:
|
||||
- id: willing-to-submit-pr
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: Are you willing to submit PR?
|
||||
label: Are you willing to submit a PR?
|
||||
description: This is absolutely not required, but we are happy to guide you in the contribution process.
|
||||
options:
|
||||
- Undecided
|
||||
|
||||
@@ -4,9 +4,9 @@ body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This template can be used to create issues that don't fit any of the other templates. Valid examples include meta issues or other task tracking issues to help coordinate work, or informative issues that are kept around to appear in searches.
|
||||
This template can be used to create issues that don't fit any of the other templates. Valid examples include meta issues or other task tracking issues to help coordinate work, or informative issues that are kept for search purposes.
|
||||
|
||||
Do not use this template to submit support or help requests, they will be closed. Please use other forums such as our [Community Discord](https://discord.gg/backstage-687207715902193673) instead.
|
||||
Do not use this template to submit support or help requests, as they will be closed. Please use other forums such as our [Community Discord](https://discord.gg/backstage-687207715902193673) instead.
|
||||
- type: checkboxes
|
||||
id: acknowledgement
|
||||
attributes:
|
||||
|
||||
@@ -37,7 +37,7 @@ body:
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: '🗃️ Project Area'
|
||||
description: What project area is this issue closest related to? This will help find an owner for the issue faster.
|
||||
description: Which project area is this issue most closely related to? This will help find an owner for the issue faster.
|
||||
options:
|
||||
- Unknown
|
||||
- Auditor
|
||||
@@ -66,7 +66,7 @@ body:
|
||||
label: '🔖 Need'
|
||||
description: What is the rationale for this change, and who will benefit from it?
|
||||
placeholder: |
|
||||
Explain why this change is important and who will benefit from it. Provide context for the change, such as highlighting relevant past work in this area.
|
||||
Explain why this change is important and who will benefit from it. Provide context for the change, such as highlighting relevant past work in this area or specific use cases.
|
||||
- type: textarea
|
||||
id: proposal
|
||||
validations:
|
||||
@@ -79,7 +79,7 @@ body:
|
||||
|
||||
Including a proposed implementation is optional, but if you do, consider adding design details such as TypeScript examples, database schema, or sequence diagrams.
|
||||
|
||||
If the change requires particular care when being rolled out, it can be helpful to for example include a plan for a phased release.
|
||||
If the change requires particular care when being rolled out, it can be helpful to include a plan for a phased release.
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
@@ -101,7 +101,7 @@ body:
|
||||
- id: willing-to-submit-pr
|
||||
type: dropdown
|
||||
attributes:
|
||||
label: Are you willing to submit PR?
|
||||
label: Are you willing to submit a PR?
|
||||
description: This is absolutely not required, but we are happy to guide you in the contribution process.
|
||||
options:
|
||||
- Undecided
|
||||
|
||||
Reference in New Issue
Block a user