From 0550a3eb202694d3f2d6ca85ecadf7f8e6390c45 Mon Sep 17 00:00:00 2001 From: Martin Hochel Date: Tue, 5 Apr 2022 19:22:30 +0200 Subject: [PATCH 1/5] docs: setup github issues beta templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 129 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ 2 files changed, 137 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000000000..684e34cff5455e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,129 @@ +name: 🐞 Bug Report +description: File a bug report +title: '[Bug]: ' +labels: ['Type: Bug 🐛', 'Needs: Triage 🔍'] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: dropdown + id: lib-version + attributes: + label: Library + description: Which library is affected + options: + - React Northstart / v0 (@fluentui/react-northstart) + - React / v8 (@fluentui/react) + - React Components / vNext (@fluentui/react-components) + - Web Components (@fluentui/web-components) + validations: + required: true + + - type: textarea + id: env-info + attributes: + label: System Info + description: Output of `npx envinfo --system --npmPackages '{@fluent/*}' --browsers` + render: shell + validations: + required: true + + - type: dropdown + id: a11y-bug + attributes: + label: Are you reporting Accessibility issue? + description: | + **PLEASE NOTE:** + + 1. Do not link to, screenshot or reference a Microsoft product in this description. + 2. Our screen reader support is limited to Edge + Narrator. + - Please check ARIA component examples to ensure it is not a screen reader or browser issue. + - Issues that do not reproduce in Edge + Narrator, and aren't caused by obvious invalid aria values, should be filed with the respective screen reading software, not the Fluent UI repo. + 3. There is documentation or best practice that supports your expected behavior (review [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.1/) for accessibility guidance.) + options: + - 'yes' + - 'no' + + - type: input + id: reproduction + attributes: + label: Reproduction + description: | + Please provide a link to one of following browser tools based on library version: + - React Northstart / v0 - https://codesandbox.io/ + - React / v8 - https://aka.ms/fluentpen + - React Components / vNext - https://codesandbox.io/ + - Web Components - https://codesandbox.io/ + + Or a link to a repo that can reproduce the problem you ran into. + + **NOTE:** + + A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required. + If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. + + If no reproduction is provided after 3 days, it will be auto-closed. + validations: + required: true + + - type: textarea + id: description + attributes: + label: Bug Description + value: | + ## Actual Behavior + fill this out + + ## Expected Behavior + fill this out + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: dropdown + id: request-priority + attributes: + label: Requested priority + options: + - Blocking + - High + - Normal + - Low + validations: + required: true + + - type: input + id: products-affected + attributes: + label: Products/sites affected + placeholder: (provide if applicable) + + - type: dropdown + id: requested-help + attributes: + label: Are you willing to submit a PR to fix? + options: + - 'yes' + - 'no' + validations: + required: true + + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. + required: true + - label: The provided reproduction is a minimal reproducible example of the bug. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000000..afd4eed20f19eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Questions & Discussions + url: https://github.com/microsoft/fluentui/discussions + about: Use GitHub discussions for message-board style questions and discussions. + - name: Questions via Stack Overflow + url: https://stackoverflow.com/questions/tagged/fluentui + about: Please use Stack Overflow for questions `#fluentui-react`, `#fluentui` From 020d96c624eca789bf20edeb9c334ae6b7e41e6a Mon Sep 17 00:00:00 2001 From: Martin Hochel Date: Tue, 5 Apr 2022 20:27:41 +0200 Subject: [PATCH 2/5] docs: deprecate old issue templates --- .github/ISSUE_TEMPLATE/accessibility_issue.md | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/accessibility_issue.md b/.github/ISSUE_TEMPLATE/accessibility_issue.md index a4215760326063..36f49ae4f3a698 100644 --- a/.github/ISSUE_TEMPLATE/accessibility_issue.md +++ b/.github/ISSUE_TEMPLATE/accessibility_issue.md @@ -1,5 +1,5 @@ --- -name: Accessibility issue +name: Accessibility issue (Deprecated) about: Have you identified an accessibility issue regarding a Fluent UI React control? --- diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 32728b4760d008..83f8440f62bf0e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,5 +1,5 @@ --- -name: Bug report +name: Bug report (Deprecated) about: Found a bug in Fluent UI React? --- From fe52132153a364899d4d906d15d67e25a07dea82 Mon Sep 17 00:00:00 2001 From: Martin Hochel Date: Tue, 5 Apr 2022 20:38:53 +0200 Subject: [PATCH 3/5] docs: setup github issues beta templates for feature request --- .github/ISSUE_TEMPLATE/feature-request.yml | 55 ++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000000000..4cadcd955a3bb7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,55 @@ +name: "\U0001F680 New feature proposal" +description: Propose a new feature to be added to Fluent UI +title: '[Feature]: ' +labels: ['Type: Feature', 'Needs: Triage 🔍'] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for your interest in the project and taking the time to fill out this feature report! + + - type: dropdown + id: lib-version + attributes: + label: Library + description: To which library would this be added to + options: + - React Northstart / v0 (@fluentui/react-northstart) + - React / v8 (@fluentui/react) + - React Components / vNext (@fluentui/react-components) + - Web Components (@fluentui/web-components) + validations: + required: true + + - type: textarea + id: feature-description + attributes: + label: Describe the feature that you would like added + validations: + required: true + + - type: input + id: feature-discussed-with + attributes: + label: Have you discussed this feature with our team + description: Please use particular person or team github handle + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context or screenshots about the feature request here. + validations: + required: false + + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. + required: true From 180f4de91aff95981aaada2ae050b15b9b6d1b95 Mon Sep 17 00:00:00 2001 From: Martin Hochel Date: Tue, 5 Apr 2022 20:39:37 +0200 Subject: [PATCH 4/5] fixup! docs: deprecate old issue templates --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e9b1813cb6b580..98323149276106 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: Feature request +name: Feature request (Deprecated) about: Do you have feature or improvement suggestion for Fluent UI React? --- From bbbacc36137e9a04dec1d4fc7edf3a0fdd874699 Mon Sep 17 00:00:00 2001 From: Martin Hochel Date: Mon, 11 Apr 2022 13:16:33 +0200 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Oleksandr Fediashov Co-authored-by: Justin Slone <40304143+JustSlone@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.yml | 8 ++++---- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 684e34cff5455e..f685c1535f549a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -15,9 +15,9 @@ body: label: Library description: Which library is affected options: - - React Northstart / v0 (@fluentui/react-northstart) + - React Northstar / v0 (@fluentui/react-northstar) - React / v8 (@fluentui/react) - - React Components / vNext (@fluentui/react-components) + - React Components / v9 (@fluentui/react-components) - Web Components (@fluentui/web-components) validations: required: true @@ -53,9 +53,9 @@ body: label: Reproduction description: | Please provide a link to one of following browser tools based on library version: - - React Northstart / v0 - https://codesandbox.io/ + - React Northstar / v0 - https://codesandbox.io/s/fluent-ui-template-8ismt - React / v8 - https://aka.ms/fluentpen - - React Components / vNext - https://codesandbox.io/ + - React Components / v9 - https://codesandbox.io/ - Web Components - https://codesandbox.io/ Or a link to a repo that can reproduce the problem you ran into. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 4cadcd955a3bb7..37aafadfb75a31 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -15,9 +15,9 @@ body: label: Library description: To which library would this be added to options: - - React Northstart / v0 (@fluentui/react-northstart) + - React Northstar / v0 (@fluentui/react-northstar) - React / v8 (@fluentui/react) - - React Components / vNext (@fluentui/react-components) + - React Components / v9 (@fluentui/react-components) - Web Components (@fluentui/web-components) validations: required: true