From 9b8336bc10fd868886cafe862e18a4d3471d1011 Mon Sep 17 00:00:00 2001 From: Animesh Kumar Date: Sat, 20 Jul 2024 11:18:01 +0530 Subject: [PATCH 1/4] feat: introduce new design issue section Changes: - add initial template for the design issue --- .github/ISSUE_TEMPLATE/design.yml | 70 +++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/design.yml diff --git a/.github/ISSUE_TEMPLATE/design.yml b/.github/ISSUE_TEMPLATE/design.yml new file mode 100644 index 00000000..56c552a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/design.yml @@ -0,0 +1,70 @@ +name: "insert pallet emoji" Design Proposal +description: Suggest a new design idea +title: "[DESIGN] " +labels: ["design"] + +body: + - type: textarea + id: need_improvement + attributes: + label: Why do we need this improvement? + validations: + required: true + + - type: textarea + id: change + attributes: + label: How will this change help? + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + + + - type: textarea + id: implemented + attributes: + label: How could it be implemented/designed? + validations: + required: true + + - type: dropdown + id: breakingchange + attributes: + label: "🚧 Breaking changes" + description: "Will this be a breaking change?" + options: + - "Yes" + - "No" + validations: + required: true + + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you checked for similar open issues?" + options: + - label: "I checked and didn't find a similar issue" + required: true + + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "🏢 Have you read the Contributing Guidelines?" + options: + - label: "I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)" + required: true + + - type: dropdown + 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. + options: + - "Yes I am willing to submit a PR!" + - "No, someone else can work on it." \ No newline at end of file From 8b62a8019b488b6edeaa013ba5ec66a99ea4cdb2 Mon Sep 17 00:00:00 2001 From: Animesh Kumar Date: Sat, 20 Jul 2024 11:34:35 +0530 Subject: [PATCH 2/4] add palette emoji --- .github/ISSUE_TEMPLATE/design.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/design.yml b/.github/ISSUE_TEMPLATE/design.yml index 56c552a3..9693d5a1 100644 --- a/.github/ISSUE_TEMPLATE/design.yml +++ b/.github/ISSUE_TEMPLATE/design.yml @@ -1,4 +1,4 @@ -name: "insert pallet emoji" Design Proposal +name: 🎨 Design Proposal description: Suggest a new design idea title: "[DESIGN] " labels: ["design"] @@ -67,4 +67,4 @@ body: description: This is absolutely not required, but we are happy to guide you in the contribution process. options: - "Yes I am willing to submit a PR!" - - "No, someone else can work on it." \ No newline at end of file + - "No, someone else can work on it." From 645d1d7950a9bbe4990b6d3517329741250560cf Mon Sep 17 00:00:00 2001 From: Animesh Kumar Date: Tue, 3 Sep 2024 12:15:24 +0530 Subject: [PATCH 3/4] fix: update format of issue: Changes: - update issue format according to the issue guideline provided here: https://github.com/asyncapi/.github/pull/308#issuecomment-2287380660 --- .github/ISSUE_TEMPLATE/design.yml | 70 ++++++++++++++++++------------- 1 file changed, 40 insertions(+), 30 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/design.yml b/.github/ISSUE_TEMPLATE/design.yml index 9693d5a1..ce877deb 100644 --- a/.github/ISSUE_TEMPLATE/design.yml +++ b/.github/ISSUE_TEMPLATE/design.yml @@ -1,20 +1,22 @@ -name: 🎨 Design Proposal +name: Design Issue Report 🎨 description: Suggest a new design idea -title: "[DESIGN] " +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 @@ -22,49 +24,57 @@ body: 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 \ No newline at end of file From 70068d46742baf0b302fcc13ef91a2b4ff06c815 Mon Sep 17 00:00:00 2001 From: Animesh Kumar Date: Mon, 30 Sep 2024 16:17:09 +0530 Subject: [PATCH 4/4] Update design.yml added suggestions from: https://github.com/asyncapi/.github/pull/308#issuecomment-2367460021 --- .github/ISSUE_TEMPLATE/design.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/design.yml b/.github/ISSUE_TEMPLATE/design.yml index ce877deb..9ed38fe7 100644 --- a/.github/ISSUE_TEMPLATE/design.yml +++ b/.github/ISSUE_TEMPLATE/design.yml @@ -72,9 +72,11 @@ body: - 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: - label: Yes, I am interested in contributing to the fix. required: true - label: No, I am just reporting the issue. - required: true \ No newline at end of file + required: true