-
-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Switch issue templates to yml (#371)
* Updated issue templates to use yml With this new issue layout, we will be matching 3 cases in the docs. E.g. https://github.com/foreign-affairs/PyFunceble-docs/blob/48536f503d073d1ad8d0e5be1d2dc4b66c13196c/docs/contributing/contributing.md?plain=1#L138 * Update ISSUE_TEMPLATE. I reviewed the templates as if I was an outsider. Let's keep things clean. --------- Co-authored-by: funilrys <[email protected]>
- Loading branch information
Showing
10 changed files
with
325 additions
and
98 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| name: Bug Report | ||
| description: Report a but or issue. | ||
| title: BUG | My Awesome Bug | ||
| labels: | ||
| - bug | ||
| projects: | ||
| - funilrys/6 | ||
| assignees: | ||
| - funilrys | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: |+ | ||
| Thanks for taking the time to fill out this bug report! | ||
| Please be patient and rest assured that we will get back to you as soon as possible. | ||
| To help us understand and reproduce the issue, please provide as much information as possible. | ||
| If you have a question or need help, please ask in our [Discussions](https://github.com/funilrys/PyFunceble/discussions) section. | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: What is the problem you are experiencing? | ||
| description: Please describe the problem you are experiencing. | ||
| placeholder: | | ||
| I am experiencing a problem where... | ||
| value: | | ||
| I am experiencing a problem where... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: How can we reproduce the problem? | ||
| description: Please describe how we can reproduce the problem. | ||
| placeholder: | | ||
| To reproduce the problem: | ||
| 1. | ||
| 2. | ||
| 3. | ||
| 4. | ||
| value: | | ||
| To reproduce the problem: | ||
| 1. | ||
| 2. | ||
| 3. | ||
| 4. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: screenshot | ||
| attributes: | ||
| label: Do you have a screenshot? | ||
| description: | | ||
| If applicable to the problem, please provide some screenshots to help explain the problem. | ||
| placeholder: | | ||
| <details><summary>Screenshot</summary> | ||
| </details> | ||
| value: | | ||
| <details><summary>Screenshot</summary> | ||
| </details> | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: What did you expect to happen? | ||
| description: Please describe what you expected to happen. | ||
| placeholder: | | ||
| I expected that... | ||
| value: | | ||
| I expected that... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: workaround | ||
| attributes: | ||
| label: Is there a workaround? | ||
| description: Please describe if there is a workaround. | ||
| placeholder: | | ||
| I found a workaround... | ||
| value: | | ||
| I found a workaround... | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: configuration | ||
| attributes: | ||
| label: How did you configure PyFunceble? | ||
| description: | | ||
| Please provide a representation of the non-default configuration you used or the content of your `.PyFunceble.overwrite.yaml` file. | ||
| placeholder: | | ||
| ```yaml | ||
| # .PyFunceble.overwrite.yaml | ||
| # Your configuration here. | ||
| ``` | ||
| value: | | ||
| ```yaml | ||
| .PyFunceble.overwrite.yaml | ||
| # Your configuration here | ||
| ``` | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: dropdown | ||
| id: OS | ||
| attributes: | ||
| label: Which Operating System did you use? | ||
| description: | | ||
| Please select the operating system you used. | ||
| multiple: true | ||
| options: | ||
| - Arch Linux | ||
| - Debian 12 | ||
| - Debian 11 | ||
| - Debian 10 | ||
| - Ubuntu 24.04 LTS | ||
| - Ubuntu 23.10 | ||
| - Ubuntu 22.04 LTS | ||
| - Ubuntu 20.04 LTS | ||
| - Linux Other | ||
| - Unix or *BSD like OS | ||
| - MacOS | ||
| - Windows 10 | ||
| - Windows 11 | ||
| - Windows Server 2016 | ||
| - Windows Server 2019 | ||
| - Windows Server 2022 | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: dropdown | ||
| id: python_version | ||
| attributes: | ||
| label: Which Python Version did you use? | ||
| description: | | ||
| Please select the Python version you used. | ||
| multiple: true | ||
| options: | ||
| - "3.8" | ||
| - "3.9" | ||
| - "3.10" | ||
| - "3.11" | ||
| - "3.12" | ||
| - "3.13" | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: input | ||
| id: pyFunceble_version | ||
| attributes: | ||
| label: Which PyFunceble Version did you use? | ||
| description: | | ||
| Please provides the output of the `pyfunceble --version` command. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: additional | ||
| attributes: | ||
| label: Additional context | ||
| description: Please provide any additional context related to the problem. | ||
| placeholder: | | ||
| I would like to add... | ||
| value: | | ||
| I would like to add... | ||
| 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,88 @@ | ||
| name: Feature Request | ||
| description: Suggest an idea for this project. | ||
| title: "Feature Request | My Awesome Idea" | ||
| labels: | ||
| - enhancement | ||
| projects: | ||
| - funilrys/6 | ||
| assignees: | ||
| - funilrys | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: |+ | ||
| Thanks for taking the time to fill out this feature request! | ||
| lease be patient and rest assured that we will get back to you as soon as possible. | ||
| To help us understand and reproduce the issue, please provide as much information as possible. | ||
| If you have a question or need help, please ask in our [Discussions](https://github.com/funilrys/PyFunceble/discussions) section. | ||
| - type: textarea | ||
| id: feature | ||
| attributes: | ||
| label: What is the feature you'd like to request? | ||
| description: Please describe the feature you'd like to request. | ||
| placeholder: | | ||
| I'd like to request a feature that... | ||
| value: | | ||
| I'd like to request a feature that... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: What problem are you trying to solve? | ||
| description: Please describe the problem you are trying to solve. | ||
| placeholder: | | ||
| I'm trying to solve a problem where... | ||
| value: | | ||
| I'm trying to solve a problem where... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: What solution would you like to see? | ||
| description: Please describe the solution you'd like to see. | ||
| placeholder: | | ||
| I'd like to see a solution that... | ||
| value: | | ||
| I'd like to see a solution that... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Are there any alternatives you've considered? | ||
| description: Please describe any alternatives you've considered. | ||
| placeholder: | | ||
| I've considered alternatives such as... | ||
| value: | | ||
| I've considered alternatives such as... | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: additional | ||
| attributes: | ||
| label: Additional context | ||
| description: Please provide any additional context or screenshots. | ||
| placeholder: | | ||
| I would like to add... | ||
| value: | | ||
| I would like to add... | ||
| validations: | ||
| required: false | ||
|
|
||
| # - type: checkboxes | ||
| # id: terms | ||
| # attributes: | ||
| # label: Code of Conduct | ||
| # description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.org/todo). | ||
| # options: | ||
| # - label: I agree to follow this project's Code of Conduct | ||
| # 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 |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| name: Documentation Improvement Request | ||
| description: Suggestions for improving the documentation. | ||
| title: "Documentation | My Awesome Idea" | ||
| labels: | ||
| - documentation | ||
| projects: | ||
| - funilrys/6 | ||
| assignees: | ||
| - funilrys | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: |+ | ||
| Thanks for taking the time to fill out this documentation improvement request! | ||
| lease be patient and rest assured that we will get back to you as soon as possible. | ||
| To help us understand and reproduce the issue, please provide as much information as possible. | ||
| If you have a question or need help, please ask in our [Discussions](https://github.com/funilrys/PyFunceble/discussions) section. | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: What is missing or not easy to understand? | ||
| description: | | ||
| Please describe what is missing or not easy to understand in the documentation. | ||
| placeholder: | | ||
| I've found it hard to understand how... | ||
| value: | | ||
| I've found it hard to understand how... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: suggestion | ||
| attributes: | ||
| label: What is your suggestion or improvement? | ||
| description: | | ||
| A clear description of your suggestion and what you would like to improve and how you would like to improve it. | ||
| placeholder: | | ||
| I suggest that we... | ||
| value: | | ||
| I suggest that we... | ||
| validations: | ||
| required: true |
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,8 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Discussions | ||
| url: https://github.com/funilrys/PyFunceble/discussions | ||
| about: Please ask and answer questions here. | ||
| - name: Documentation | ||
| url: https://docs.pyfunceble.com | ||
| about: Find more information about PyFunceble through our documentation. |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.