-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changes: - update issue format according to the issue guideline provided here: #308 (comment)
- Loading branch information
1 parent
8b62a80
commit 645d1d7
Showing
1 changed file
with
40 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,80 @@ | ||
name: 🎨 Design Proposal | ||
name: Design Issue Report 🎨 | ||
description: Suggest a new design idea | ||
title: "[DESIGN] <description>" | ||
title: "[DESIGN]: (Brief, descriptive title of the issue)" | ||
labels: ["design"] | ||
|
||
body: | ||
- type: textarea | ||
id: need_improvement | ||
id: issue-description | ||
attributes: | ||
label: Why do we need this improvement? | ||
label: Describe the Issue | ||
description: Please describe the design issue you’ve encountered clearly and concisely. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: change | ||
id: outcome | ||
attributes: | ||
label: How will this change help? | ||
label: Expected Outcome | ||
description: What should the design look like, or how should it behave? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: Screenshots | ||
description: Please add screenshots if applicable | ||
description: Attach any screenshots or visuals that help illustrate the issue. | ||
validations: | ||
required: false | ||
|
||
|
||
- type: textarea | ||
id: implemented | ||
id: steps-reproduce | ||
attributes: | ||
label: How could it be implemented/designed? | ||
label: Steps to Reproduce | ||
description: | | ||
1. Open the Design File/Tool: [e.g., “Open the Figma file named ‘Homepage Design’.”] | ||
2. Go to the Issue Area: [e.g., “Navigate to the ‘Header’ section on the ‘Home’ page.”] | ||
3. Perform the Action: [e.g., “Change the font size of the text box.”] | ||
4. See the Result: [e.g., “Notice that the text overlaps with other elements.”] | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: breakingchange | ||
- type: textarea | ||
id: device-info | ||
attributes: | ||
label: "🚧 Breaking changes" | ||
description: "Will this be a breaking change?" | ||
options: | ||
- "Yes" | ||
- "No" | ||
label: Browser/Device | ||
description: What browser or device were you using? | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: no-duplicate-issues | ||
- type: textarea | ||
id: extra-info | ||
attributes: | ||
label: "👀 Have you checked for similar open issues?" | ||
options: | ||
- label: "I checked and didn't find a similar issue" | ||
required: true | ||
label: Additional Notes | ||
description: Include any other relevant information or context. | ||
validations: | ||
required: false | ||
|
||
- type: checkboxes | ||
id: read-code-of-conduct | ||
id: check-before-submission | ||
attributes: | ||
label: "🏢 Have you read the Contributing Guidelines?" | ||
label: Check Before Submitting | ||
options: | ||
- label: "I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)" | ||
- label: I have looked for similar issues to avoid duplicates. | ||
required: true | ||
- label: I have reviewed the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md). | ||
required: true | ||
|
||
- type: dropdown | ||
- type: checkboxes | ||
id: help-fixing | ||
attributes: | ||
label: Are you willing to work on this issue? | ||
description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
label: Would you like to help fix this issue? (Not required, but appreciated!) | ||
options: | ||
- "Yes I am willing to submit a PR!" | ||
- "No, someone else can work on it." | ||
- label: Yes, I am interested in contributing to the fix. | ||
required: true | ||
- label: No, I am just reporting the issue. | ||
required: true |