From b170c1b1adf20eca7d5bd6999c7d90509fc552f6 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Sun, 21 Jul 2024 21:19:53 +0100 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 31 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 68 ++++++++++++++++++++++ .github/pull_request_template.md | 19 ++++++ 4 files changed, 119 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..ac6cf8c463 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,31 @@ +name: 🐛 Bug Report +description: Create a bug report to help improve! +labels: [bug] +body: + - type: markdown + attributes: + value: | + ##### ⏱️ Before you start... + - Are you sure that you are looking at the most recent version of the repo? + - Have you checked whether or not a similar bug has already been reported? + - type: textarea + attributes: + label: 🪟 What file(s) are this issue present in? + placeholder: /assets/Rainbow flag/3D + validations: + required:true + - type: textarea + attributes: + label: 📄 Description + description: A clear and concise description of what the error is. + validations: + required: true + - type: textarea + attributes: + label: 🤔 Expected outcome + description: What exactly should this emoji look like? + - type: textarea + attributes: + label: 📸 Assets + description: | + A list of assets (errors, screenshots, emoji) relevant to the bug. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..3ba13e0cec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..d8c8e127d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,68 @@ +name: ✨ Feature Request +description: Request a new feature to make things better! +labels: [feature request] +body: + - type: markdown + attributes: + value: | + ##### ⏱️ Before you start... + - Have you checked whether or not a similar feature request has already been reported? + - type: textarea + attributes: + label: 📄 Description + description: A clear and concise description of what your idea is. Include things like possible use cases, drawbacks, etc. + validations: + required: true + - type: textarea + attributes: + label: 🗃️ Alternative solutions + description: Describe more ways this idea could be implemented. + validations: + required: false + - type: textarea + id: api-changes + attributes: + label: ⚡ API Changes + description: Include a list of all API changes, additions, subtractions as would be required by your proposal. These APIs should be considered placeholders, so the naming is not as important as getting the concepts correct. If possible you should include some example (pseudo-)code of usage of your new API. + placeholder: | + ```csharp + var button = new Button (); + button.MakeShiny = true; // new API + ``` + + The MakeShiny API works even if the button is already visible. + validations: + required: false + - type: textarea + id: use-case + attributes: + label: 👥 Intended Use-Case + description: Provide a detailed example of where your proposal would be used and for what purpose. Focus on _why_ you want this feature instead of _what_ the feature does. + placeholder: I have a situation where I would really want a shiny button to make it stand out from the rest of the plain and boring buttons. + validations: + required: false + - type: textarea + attributes: + label: ✅ Tasks + description: Give an overview of all the specific things you would like to be changed or implemented. + value: | + ```[tasklist] + ### High Priority + - [ ] Something + - [ ] Another thing + - [ ] https://github.com/link/to/an/issue + ``` + ```[tasklist] + ### Nice to have + - [ ] Something + - [ ] Another thing + - [ ] https://github.com/link/to/an/issue + ``` + validations: + required: false + - type: textarea + attributes: + label: 📸 Assets + description: A list of assets (screenshots, mockups) relevant to this feature request. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..5591c47971 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ + + +### 📄 Description + + +### ✅ Tasks + + +#### Nice to have +- [ ] Something +- [ ] Another thing +- [ ] https://github.com/microsoft/fluentui-emoji/issues/link-to-an-issue + +### 📸 Assets + +