diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ddd6f4ef0..0625513fa 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,47 +1,40 @@ -name: Bug Report -description: Create a bug report to help improve FluentHub +name: 🐛 Bug Report +description: Create a bug report to help us improve FluentHub! labels: [bug] -assignees: [onein528] +assignees: [0x5bfa] +title: "Bug: " body: - - type: checkboxes - attributes: - label: Before you start - options: - - label: Have you updated FluentHub? You might be using an old version. - required: true - - label: Have you checked if a similar issue has already been reported? - required: true - type: dropdown id: windows attributes: - label: What version of Windows is this issue present? + label: 🪟 What version of Windows is this issue present? multiple: true options: - - Windows 10 - - Windows 10 Release Preview - - Windows 10 Beta - - Windows 10 Dev - - Windows 11 - - Windows 11 Release Preview - - Windows 11 Beta - - Windows 11 Dev + - 🪟 Windows 10 + - 🪟 Windows 10 Release Preview + - 🪟 Windows 10 Beta + - 🪟 Windows 10 Dev + - 🪟 Windows 11 + - 🪟 Windows 11 Release Preview + - 🪟 Windows 11 Beta + - 🪟 Windows 11 Dev validations: required: true - type: textarea attributes: - label: What version/architecture of FluentHub are you on? + label: 🔢 What version of FluentHub are you on? description: Copy and paste the version from the about page of FluentHub's settings. If you're building from GitHub, simply provide the commit hash you built on. validations: required: true - type: textarea attributes: - label: Description + label: 📄 Description description: A clear and concise description of what the bug is. validations: required: true - type: textarea attributes: - label: Steps To Reproduce + label: 🪜 Steps To Reproduce description: Steps to reproduce the behavior. placeholder: | 1. Go to '....' @@ -52,13 +45,16 @@ body: required: false - type: textarea attributes: - label: Expected behavior + label: 🤔 Expected behavior description: A clear and concise description of what you expected to happen. - validations: - required: true + - type: textarea + id: workaround + attributes: + label: ⚒️ Did you find any workaround? + description: Did you find any workaround for this issue? This can unblock other people while waiting for this issue to be resolved or even give us a hint on how to fix this. - type: textarea attributes: - label: Stack Trace + label: 📑 Stack Trace description: Copy and paste the stack trace from FluentHub's error page. value: |
Stack trace details
@@ -72,6 +68,6 @@ body: required: true - type: textarea attributes: - label: Assets + label: 📸 Assets description: | - A list of assets (errors, screenshots, logs) relevant to the bug. + A list of assets (errors, screenshots) relevant to the bug. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..705030180 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Discord + url: https://discord.com/invite/8KtRkjq2Q4 + about: You can discuss products and services on Discord, too! diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 106709277..d78475b97 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,27 +1,64 @@ -name: Feature Request -description: Request a new feature for FluentHub +name: ✨ Feature Request +description: Request a new feature to make things better! labels: [feature request] +title: "Feature: " body: - - type: checkboxes - attributes: - label: Before you start... - options: - - label: Have you checked if a similar feature request has already been reported? - required: true - type: textarea attributes: - label: Description + 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 + label: 🗃️ Alternative solutions description: Describe more ways this idea could be implemented. validations: required: false - type: textarea + id: required-changes + attributes: + label: ⚡ Required changes + description: Include a list of all required changes in the code, i.e. additions, subtractions as would be required by your proposal. These changes 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 that illustrates your proposal. + 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: Assets - description: | - A list of assets (screenshots, mockups) relevant to this feature request. + 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/ISSUE_TEMPLATE/spec.yml b/.github/ISSUE_TEMPLATE/spec.yml new file mode 100644 index 000000000..f385c8fe8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spec.yml @@ -0,0 +1,81 @@ +name: ✏️ Spec +description: An official specification for enhancements. +labels: ["enhancement"] +title: "Spec: " +assignees: [] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to provide us with a detailed specification of your idea. + + In a spec you will give a detailed and complete representation of the (public) APIs that are implemented as part of this change. Additionally please think about backwards compatibility, breaking changes, supported platforms and the difficulty. + - type: textarea + id: description + attributes: + label: 📄 Description + description: Provide a concise description of the feature and the motivation for adding it. This can be a modified version from the feature request prior to this. + validations: + required: true + - type: textarea + id: api-changes + attributes: + label: ⚡ API Changes + description: Include a complete list of all API changes, additions, subtractions as would be required by your proposal. + value: | + # [ class ] + + ## Properties + + | API | Description | + | ------------- | ------------- | + | [name] | Gets or sets [description]. | + + ## Events + + | API | Description | + | ------------- | ------------- | + | [name] | [API documentation/description] | + validations: + required: true + - type: textarea + id: usage-scenarios + attributes: + label: 👥 Usage scenarios + description: Give us a couple of scenarios that demonstrate how developers would consume the above APIs. + placeholder: | + # C# Example + ```csharp + var thing = new MyNewControl(); + thing.BeAwesome = true; + thing.Color = Colors.Cornsilk; + ``` + + # XAML Example + ```xaml + + ``` + validations: + required: true + - type: textarea + id: backwards-compatibility + attributes: + label: 🔙 Backward Compatibility + description: Please describe here anything in terms of backwards compatibility. Will there be breaking changes? Do we need to update dependencies to support this? What are the minimum supported API/OS levels? And lastly, are there any platforms that can't support this and why? + placeholder: | + Minimum API levels? + Breaking changes? + Unsupported platforms? + validations: + required: false + - type: dropdown + id: difficulty + attributes: + label: 🤔 Difficulty + description: What do you feel will be the difficulty of this change all things considering? No exact science, just your gut feeling. + options: + - Low + - Medium + - High + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 83c925958..45fea4e5a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,38 @@ -### Description + -### Motivation and Context +### 📄 Description + -### Change Area +### 💭 Motivation and context + -- [ ] Documentation -- [ ] CI -- [ ] Code -- [ ] Design -### PR Checklit +### 🗃️ Alternative solutions + + +### ✅ Tasks + + +```[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 +``` + +#### ☑️ PR checklist + +```[tasklist] +### PR checklist - [ ] Were these changes approved in an discussion by the project maintainers to prevent from extra work? - [ ] Did you build the app and test your changes? - [ ] Did you check for accessibility? You can use Accessibility Insights for this. @@ -18,7 +40,8 @@ - [ ] Did you implement any design changes to an existing feature? - [ ] Was this change approved? - [ ] Are there any other steps that were used to validate these changes? - 1. - 2. +``` -### Screenshots +### 📸 Assets +