From 16d90025d77d49457243c13d302e81f46781dd3c Mon Sep 17 00:00:00 2001 From: funilrys Date: Thu, 3 Oct 2024 14:50:24 +0200 Subject: [PATCH] Update ISSUE_TEMPLATE. I reviewed the templates as if I was an outsider. Let's keep things clean. --- .github/ISSUE_TEMPLATE/00-bug.yml | 180 ++++++++++++++++++ .github/ISSUE_TEMPLATE/01-bug_report.yml | 135 ------------- .github/ISSUE_TEMPLATE/01-feature-request.yml | 88 +++++++++ .github/ISSUE_TEMPLATE/02-feature_request.yml | 48 ----- .github/ISSUE_TEMPLATE/03-documentation.yml | 53 ++++-- .github/ISSUE_TEMPLATE/bug_report.md | 46 ----- .github/ISSUE_TEMPLATE/config.yaml | 1 - .github/ISSUE_TEMPLATE/config.yml | 8 + .github/ISSUE_TEMPLATE/documentation.md | 15 -- .github/ISSUE_TEMPLATE/feature_request.md | 25 --- .github/ISSUE_TEMPLATE/help.md | 11 -- 11 files changed, 311 insertions(+), 299 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/00-bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/01-bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/01-feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/02-feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/config.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/help.md diff --git a/.github/ISSUE_TEMPLATE/00-bug.yml b/.github/ISSUE_TEMPLATE/00-bug.yml new file mode 100644 index 000000000..be55d764e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-bug.yml @@ -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: | +
Screenshot + + +
+ value: | +
Screenshot +
+ 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 diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml deleted file mode 100644 index 8a6dde8ac..000000000 --- a/.github/ISSUE_TEMPLATE/01-bug_report.yml +++ /dev/null @@ -1,135 +0,0 @@ -name: Bug report -description: | - Create a bug report to help us improve and fix undocumented or unknown - issues. -title: 'BUG: ' -assignees: - - funilrys -labels: bug -projects: ['spirillen/ITT', 'funilrys/pyfunceble'] -body: - - type: textarea - id: bug_description - attributes: - label: What happened? - description: | - Please be as clear as possible in your description of what the bug is. - placeholder: Thanks for taking the time to fill out this bug report! - validations: - required: true - - - type: textarea - id: configuration - attributes: - label: Configuration? - description: | - A clear representation of what you changed into the `.PyFunceble.yaml` and/or what you put into your `.PyFunceble.overwrite.yaml` file. - placeholder: Tell us what you see! - validations: - required: false - - - type: textarea - id: Reproduction - attributes: - label: Reproduction - description: | - A clear description of the steps to follow to reproduce the behavior. - placeholder: | - 1. - 2. - 3. - 4. - validations: - required: false - - - type: textarea - id: expected_behaviour - attributes: - label: Expected behaviour - description: | - A clear and concise description of what you expected to happen. - placeholder: - validations: - required: false - - - type: textarea - id: screenshot - attributes: - label: Screenshot - description: | - If applicable, add screenshots to help explain your problem. - placeholder: | - "![Screenshot of example.com](img-src)" - **INFO**: You can copy paste images directly into this field. - value: | -
Screenshot - - -
- validations: - required: false - - - type: dropdown - id: OS - attributes: - label: Operating System - description: What is your Operating System where you found this bug - multiple: true - options: - - Arch Linux (6.9.3) - - Arch Linux (6.8.8) - - Arch Linux (6.8.2) - - Arch Linux (6.7.6) - - Debian 12 - - Debian 11 - - Debian 10 - - Ubuntu 24.04 LTS - - Ubuntu 23.10 - - Ubuntu 22.04 LTS - - Ubuntu 20.04 LTS - - Linux Other - - Unix. *BSD like OS - - Spyware OS socks like Windows or MacOS - # That typo isn't a accident *smirk* - - # You need to use "" when the option starts or ends with a Zero - - type: dropdown - id: python_version - attributes: - label: Python Version - description: What python version did you use - multiple: true - options: - - '3.8' - - '3.9' - - '3.10' - - '3.11' - - '3.12' - - '3.13' - - '3.14' - - '4.x' - - - type: dropdown - id: pyFunceble_version - attributes: - label: PyFunceble Version - description: Which PyFunceble Version did you use - multiple: true - options: - - 4.2.24-dev - - 4.2.23-dev - - 4.2.22-dev - - 4.2.21-dev - - 4.2.20-dev - - 4.2.19-dev - - 4.2.0 - - 4.1.0 - - 4.1.2 - - 4.1.3 - - - type: textarea - id: additional - attributes: - label: Additional info - description: Additional information you might like to add. - placeholder: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/01-feature-request.yml b/.github/ISSUE_TEMPLATE/01-feature-request.yml new file mode 100644 index 000000000..0db9a42d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-feature-request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/02-feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature_request.yml deleted file mode 100644 index 8571db4bb..000000000 --- a/.github/ISSUE_TEMPLATE/02-feature_request.yml +++ /dev/null @@ -1,48 +0,0 @@ -name: Feature request (@PyFunceble) -description: | - Suggest a feature or an idea for this project. -title: 'FEATURE: ' -assignees: - - funilrys -labels: - - features - - enhancement -projects: ['spirillen/ITT', 'funilrys/pyfunceble'] -body: - - type: textarea - id: Description - attributes: - label: Description - description: | - A clear description of the feature you wish PyFunceble had. - placeholder: | - Example: I'm always frustrated when ... - validations: - required: true - - - type: textarea - id: possible_solution - attributes: - label: Possible Solution - description: | - A clear description of the solution that you'd like. - validations: - required: true - - - type: textarea - id: considered_alternative - attributes: - label: Considered Alternative - description: | - A clear description of any alternative solutions or features you've considered. - validations: - required: false - - - type: textarea - id: additional_context - attributes: - label: Additional context - description: | - A clear description of any other context or screenshots about your feature request. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/03-documentation.yml b/.github/ISSUE_TEMPLATE/03-documentation.yml index a950f17c3..0b24d75c0 100644 --- a/.github/ISSUE_TEMPLATE/03-documentation.yml +++ b/.github/ISSUE_TEMPLATE/03-documentation.yml @@ -1,29 +1,46 @@ -name: Documentation (@PyFunceble) -description: | - Create a report to help us improve the documentation. -title: 'DOC: ' +name: Documentation Improvement Request +description: Suggestions for improving the documentation. +title: "Documentation | My Awesome Idea" +labels: + - documentation +projects: + - funilrys/6 assignees: - funilrys -labels: documentation -projects: ['spirillen/ITT', 'funilrys/pyfunceble'] body: - - type: input - id: location + - type: markdown attributes: - label: Location - description: Where did you find this text - placeholder: Please copy and pasted the full URI + 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 + id: description attributes: - label: Description - description: A clear description of the part that is missing or not easy to understand. - placeholder: I've found it hard to understand how... + 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: Suggestion / Improvement - description: A clear description of your suggestion and what you would like to improve - placeholder: Replace X with Y + 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a60d83205..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us improve and fix undocumented or unknown issues. -title: "BUG: " -labels: bug -assignees: funilrys ---- - -## Description - - - -## Configuration - - - -## Reproduction - - - - - -## Expected behavior - - - -## Screenshots - - - -## Versions - -**OS:** - -**Python Version:** - -**PyFunceble Version:** - -## Additional context - - diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml deleted file mode 100644 index 0086358db..000000000 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..06a7446b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 0045ece28..000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Documentation -about: Create a report to help us improve the documentation. -title: 'DOC: ' -labels: documentation -assignees: funilrys ---- - -## Description - - - -## Suggestion / Improvement - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 649108045..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Feature request -about: Suggest a feature or an idea for this project. -title: 'FEATURE: ' -labels: features, enhancement -assignees: funilrys ---- - -## Description - - - - - -## Possible Solution - - - -## Considered Alternative - - - -## Additional context - - diff --git a/.github/ISSUE_TEMPLATE/help.md b/.github/ISSUE_TEMPLATE/help.md deleted file mode 100644 index 86393c92d..000000000 --- a/.github/ISSUE_TEMPLATE/help.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Help Wanted -about: Ask for help. -title: "HELP: " -labels: help wanted -assignees: funilrys ---- - -## Description - -