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-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/03-documentation.yml b/.github/ISSUE_TEMPLATE/03-documentation.yml new file mode 100644 index 000000000..0b24d75c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-documentation.yml @@ -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 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 - - diff --git a/.gitignore b/.gitignore index f2d1d00c2..74e8842ad 100644 --- a/.gitignore +++ b/.gitignore @@ -103,6 +103,9 @@ venv.bak/ # mypy .mypy_cache/ +# JetBrains Tools like IntelliJ +.idea + # VSCode (Visual Basic Code) .vscode