-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GitHub: Improve issue templates (#487)
Co-authored-by: 0x5bfa <62196528+0x5bfa@users.noreply.github.com>
- Loading branch information
Showing
5 changed files
with
195 additions
and
53 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
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 |
|---|---|---|
| @@ -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! |
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,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 |
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 |
|---|---|---|
| @@ -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 | ||
| <MyNewControl x:Name="thing" BeAwesome="true" Color="Cornsilk" /> | ||
| ``` | ||
| 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 |
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,24 +1,47 @@ | ||
| ### Description | ||
| <!--⏱️ Before you start... | ||
| Have you checked whether or not a similar pull request has already been reported?--> | ||
|
|
||
| ### Motivation and Context | ||
| ### 📄 Description | ||
| <!--A clear and concise description of what your idea is. Include things like possible use cases, drawbacks, etc.--> | ||
|
|
||
| ### Change Area | ||
| ### 💭 Motivation and context | ||
| <!-- Why did you choose to implement this?--> | ||
|
|
||
| - [ ] Documentation | ||
| - [ ] CI | ||
| - [ ] Code | ||
| - [ ] Design | ||
|
|
||
| ### PR Checklit | ||
| ### 🗃️ Alternative solutions | ||
| <!--Describe more ways this idea could be implemented.--> | ||
|
|
||
|
|
||
| ### ✅ Tasks | ||
| <!--Give an overview of all the specific things you would like to be changed or implemented. | ||
| If an issue already exists with this, you can add the issue link or number--> | ||
|
|
||
| ```[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. | ||
| - [ ] Did you remove any strings from the en-us resource file after seeing if the string wasn't being used? | ||
| - [ ] 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 | ||
| <!--A list of assets (screenshots, mockups) relevant to this feature request. | ||
| You can also include GitHub citations (if you know what these are).--> |