This repository has been archived by the owner on Jan 16, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
263 additions
and
90 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,101 @@ | ||
| name: "🐛 Bug report" | ||
| description: "Unexpected program behaviour that needs code correction" | ||
| labels: ["🐛 bug", "👀 evaluation"] | ||
| body: | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| label: Checklist | ||
| description: Ensure that our bug report form is appropriate for you. | ||
| options: | ||
| - label: I read and understood the **[Contributing Guidelines](https://github.com/Abrynos/Implement.Net/blob/master/.github/CONTRIBUTING.md)**. | ||
| required: true | ||
| - label: This is not a **[question](https://github.com/Abrynos/Implement.Net/discussions)**. | ||
| required: true | ||
| - label: This is not a **[technical issue](https://github.com/Abrynos/Implement.Net/discussions)**. | ||
| required: true | ||
| - label: This is not a **[duplicate](https://github.com/Abrynos/Implement.Net/issues)** of an existing issue. | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: If you are using a version that is different from the current **[stable](https://github.com/Abrynos/Implement.Net/releases/latest)** or **[pre-release](https://github.com/Abrynos/Implement.Net/releases)**, please ensure that your bug is reproducible on at least one of them. | ||
| options: | ||
| - Latest stable release | ||
| - Latest pre-release | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: bug-description | ||
| attributes: | ||
| label: Description | ||
| description: Short explanation of what you were going to do, what did you want to accomplish? | ||
| placeholder: | | ||
| I tried to brew a coffee using the library, but upon trying the library threw a `CookieException`. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected-behaviour | ||
| attributes: | ||
| label: Expected behaviour | ||
| description: What did you expect to happen? | ||
| placeholder: | | ||
| I expected my favourite latte macchiato in a cup put below the machine hosting my program. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: actual-behaviour | ||
| attributes: | ||
| label: Current behaviour | ||
| description: What happened instead? | ||
| placeholder: | | ||
| No coffee was brewed and I was forced to use a water dispenser instead :( | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: Everything required for someone to reproduce your bug. | ||
| placeholder: | | ||
| Any code that is necessary to reproduce the bug goes in here. You can use markdown formatting to make it more easy to read. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: possible-solution | ||
| attributes: | ||
| label: Possible reason/solution | ||
| description: Not mandatory, but you can suggest a fix/reason for the bug, if known to you. | ||
| placeholder: | | ||
| If you observed something peculiar about your issue that could help us locate and fix the culprit, this is the right place. | ||
| - type: dropdown | ||
| id: help | ||
| attributes: | ||
| label: Can you help us with this bug report? | ||
| description: This library is offered for free and our resources are limited. Helping us increases the chance of fixing the problem. | ||
| options: | ||
| - Yes, I can code the solution myself and send a merge request. | ||
| - Somehow, I can test and offer feedback, but I can't code the solution. | ||
| - No, I don't have time, skills or willings for any of that. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: Additional information | ||
| description: Everything else you consider note-worthy that we didn't ask for. | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
| #### Thank you for taking the time to fill out this bug report. |
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,84 @@ | ||
| name: "📕 Documentation improvement" | ||
| description: "All issues related to documentation; mainly corrections and improvement ideas" | ||
| labels: ["📙 documentation", "👀 evaluation"] | ||
| body: | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| label: Checklist | ||
| description: Ensure that our bug report form is appropriate for you. | ||
| options: | ||
| - label: I read and understood the **[Contributing Guidelines](https://github.com/Abrynos/Implement.Net/blob/master/.github/CONTRIBUTING.md)**. | ||
| required: true | ||
| - label: This is not a **[question](https://github.com/Abrynos/Implement.Net/discussions)**. | ||
| required: true | ||
| - label: This is not a **[technical issue](https://github.com/Abrynos/Implement.Net/discussions)**. | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: class-method-property | ||
| attributes: | ||
| label: Affected class/method/property | ||
| description: Tell us the name of the class, method or property which is not properly documented in your opinion. | ||
| placeholder: | | ||
| ??? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: issue | ||
| attributes: | ||
| label: The issue | ||
| description: Please specify your issue in regards to our documentation. | ||
| placeholder: | | ||
| If you are reporting a mistake/correction, state what is wrong. | ||
| If you are suggesting an addition, explain the details. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Possible solution | ||
| description: The new or corrected text that would satisfy your issue stated above. | ||
| placeholder: | | ||
| We're no strangers to love | ||
| You know the rules and so do I | ||
| A full commitment's what I'm thinking of | ||
| You wouldn't get this from any other guy | ||
| I just wanna tell you how I'm feeling | ||
| Gotta make you understand | ||
| Never gonna give you up | ||
| Never gonna let you down | ||
| Never gonna run around and desert you | ||
| Never gonna make you cry | ||
| Never gonna say goodbye | ||
| Never gonna tell a lie and hurt you | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: help | ||
| attributes: | ||
| label: Can you help us with this improvement? | ||
| description: This library is offered for free and our resources are limited. Helping us increases the chance of making it happen. | ||
| options: | ||
| - Yes, I can add the solution myself and send a merge request. | ||
| - No, I don't have time, skills or willings for any of that. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: Additional information | ||
| description: Everything else you consider note-worthy that we didn't ask for. | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
| #### Thank you for taking the time to fill out this bug report. |
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,78 @@ | ||
| name: "✨ Feature request" | ||
| description: "Suggest an idea for this project" | ||
| labels: ["✨ enhancement", "👀 evaluation"] | ||
| body: | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| label: Checklist | ||
| description: Ensure that our bug report form is appropriate for you. | ||
| options: | ||
| - label: I read and understood the **[Contributing Guidelines](https://github.com/Abrynos/Implement.Net/blob/master/.github/CONTRIBUTING.md)**. | ||
| required: true | ||
| - label: This is not a **[question](https://github.com/Abrynos/Implement.Net/discussions)**. | ||
| required: true | ||
| - label: This is not a **[technical issue](https://github.com/Abrynos/Implement.Net/discussions)**. | ||
| required: true | ||
| - label: This is not a **[duplicate](https://github.com/Abrynos/Implement.Net/issues)** of an existing issue. | ||
| required: true | ||
| - label: This idea is not already possible. | ||
| required: true | ||
| - label: I believe my idea falls into the projects scope and should be offered as part of the built-in functionality. | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: feature-purpose | ||
| attributes: | ||
| label: Purpose | ||
| description: Purpose of the new feature - if it solves some problem, precise which in particular. If it benefits the library in some other way, precise why in particular. | ||
| placeholder: | | ||
| Present the underlying reason why this enhancement makes sense and what the context of it is. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Solution | ||
| description: What would you like to see as a solution to the purpose specified above? | ||
| placeholder: | | ||
| What would work for you? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: sufficiency | ||
| attributes: | ||
| label: Why are the currently avialable solutions not sufficient? | ||
| description: Evaluate the existing solutions in regards to your requirements. | ||
| placeholder: | | ||
| If something you are suggesting is already possible, then explain to us why the currently available solutions are not sufficient. | ||
| If it's not possible yet, then explain to us why it should be. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: help | ||
| attributes: | ||
| label: Can you help us with this feature request? | ||
| description: This library is offered for free and our resources are limited. Helping us increases the chance of making it happen. | ||
| options: | ||
| - Yes, I can code the solution myself and send a merge request. | ||
| - Somehow, I can test and offer feedback, but I can't code the solution. | ||
| - No, I don't have time, skills or willings for any of that. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: Additional information | ||
| description: Everything else you consider note-worthy that we didn't ask for. | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
| #### Thank you for taking the time to fill out this bug report. |