From 9e682aa1ff8f7429583d87b6fc0c88a729d11740 Mon Sep 17 00:00:00 2001 From: Juarez Rudsatz Date: Thu, 14 Mar 2024 14:02:31 -0300 Subject: [PATCH] ci: convert github issue templates from markdown to yaml --- .github/ISSUE_TEMPLATE/bug_report.md | 55 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 169 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 45 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 87 +++++++++++ 4 files changed, 256 insertions(+), 100 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 6a4dedb2..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve petl -title: '' -labels: 'Bug' -assignees: '' - ---- - -## Problem description - -### What's happenning - -A clear and concise description of what the bug is. Please explain: - -- what the current output/behavior is -- what's the bug is preventing you from doing -- tell if it had worked before but regressed and stopped working - -### Expected behavior - -A clear and concise description of intended behavior. Please explain: - -- what you expected to happen. -- how the current output/behavior doesn't match the intended behavior. - -## Scenario for reprodution - -### Reproducible test case - -Please provide a minimal, reproducible code sample, a copy-pastable example if possible: - -```python -# Your code here - -``` - -### Version and installation information - -Please provide the following: - -- Value of ``petl.__version__`` -- Version information for any third-party package dependencies that are relevant -- Version of Python interpreter -- Operating system (Linux/Windows/Mac) -- How petl was installed (e.g., "using pip into virtual environment", or "using conda") - -Also, if you think it might be relevant, please provide the output from ``pip freeze`` or -``conda env export`` depending on which was used to install petl. - -### Additional context - -Add any other context about the problem here. - -Also, feel free to remove all sections and text that aren't relevant. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..a8f28ef0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,169 @@ +name: Bug Report +description: File a bug report with detailed information to help us find the root cause +title: "Bug: " +labels: ["Bug"] +# projects: ["petl-developers/petl"] +# assignees: +# - juarezr +body: + - type: markdown + attributes: + value: | + ## Problem description + + Thanks for taking the time to fill out this bug report! + Please erase example text in all fields bellow and fill with details of the bug you have found. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: | + Please explain: + - what the current output/behavior is + - what's the bug is preventing you from doing + - tell if it had worked before but regressed and stopped working + placeholder: Please, tell us a clear and concise description of what the bug is and how it manifests. + value: | + Example: + When performing a specific operation using petl function XYZ, the folloing warning is emitted: + DeprecationWarning: ABC is deprecated since Python 3.9 and will be removed in a subsequent version. + The only supported action are: other, alternative, and something else. + Furthermore, when using the same code on another context, I get this error instead: + Error: Something got wrong somewhere! + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: What is the expected behavior? + description: | + Please explain: + - what did you expect to happen. + - how the current behavior doesn't match the intended behavior. + placeholder: Please, tell us what did you expect to happen, what's the intended behavior. + value: | + Example: + I would expect to be able to use petl for doing the operation I need to do. + In the current iteration, that is only possible if I do not use the other petl functionality. + Other operations, like working around the issue and doing somenthin else, also do not work. + I've tried using other function as well, but it didn't change anything. + validations: + required: true + - type: markdown + attributes: + value: | + ## Scenario for Reprodution + - type: textarea + id: reproducible-test-case + attributes: + label: Reproducible test case + description: | + Please provide a minimal, reproducible code sample, a copy-pastable example if possible. + This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + - type: markdown + attributes: + value: | + ## Context Information + - type: input + id: petl-version + attributes: + label: What version of petl are you have found the bug? + description: Please fill the range of versions you confirmed the bug + placeholder: v1.7.15 + validations: + required: true + - type: dropdown + id: python-version + attributes: + label: Version + description: What version of python are you running? + options: + - python 3.13+ + - python 3.12 + - python 3.11 + - python 3.10 + - python 3.9 + - python 3.8 + - python 3.7 + - python 3.6 + - python 3.5 + - python 3.4 + - python 3.3 + - python 3.2 + - python 3.1 + - python 3.0 + - python 2.7 + validations: + required: true + - type: dropdown + id: operating-system + attributes: + label: What OS are you seeing the problem on? + options: + - Linux + - Windows + - MacOS + - Other + validations: + required: true + - type: input + id: os-version + attributes: + label: What OS version are you using? + description: Operating system, distribution, and version + placeholder: cat /etc/os-release && uname -a + validations: + required: false + - type: dropdown + id: package-manager + attributes: + label: What package manager you used to install? + options: + - pip + - conda + - Source Code + - Other + validations: + required: true + - type: textarea + id: installed-packages + attributes: + label: What's the current installed packages? + description: | + Also, if you think it might be relevant, please provide the output from ``pip freeze`` or + ``conda env export`` depending on which was used to install petl and other packages. + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output + description: | + Please copy and paste any relevant log output. + This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + - type: markdown + attributes: + value: | + ## Additional context + - type: textarea + id: other-notes + attributes: + label: Additional Notes + description: Anything not covered or N/A + placeholder: n/a + validations: + required: false + - type: checkboxes + id: agree-to-code-of-conduct + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow the project [Code of Conduct](https://github.com/petl-developers/petl/blob/master/CODE_OF_CONDUCT.md). + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index afdbaf2f..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'Feature' -assignees: '' - ---- - -## Problem description - -### Is your feature request related to a problem? - -A clear and concise description of what the problem is. -Ex. I'm always frustrated when [...] - -## Change description - -### Describe the solution you'd like - -A clear and concise description of what you want to happen. - -Whenever relevant, please provide a code sample, of what would be the syntax, the way you -meant to use: - -```python -# Your code here - -``` - -### Advantages - -Explain why the current behavior is a problem, what the expected output/behavior -is, and why the expected output/behavior is a better solution. - -### Describe alternatives you've considered - -A clear and concise description of any alternative solutions or features you've considered. - -## Additional context - -Add any other context or information about the feature request here. -Please feel free to use whatever template makes sense. - -Also, feel free to remove all sections and text that aren't relevant. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..ec401e7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,87 @@ +name: Feature request +description: Suggest an idea for this project +title: "Feature Request: " +labels: ["Feature"] +# projects: ["petl-developers/petl"] +# assignees: +# - juarezr +body: + - type: markdown + attributes: + value: | + ## Feature request + + Thanks for taking the time to fill out this feature request! + - type: textarea + id: request-objective + attributes: + label: Explain why petl needs this feature? + description: | + Please explain: + - What would you want to achieve with this request? + - Is your feature request related to a problem or shortcoming? + - Why the current behavior is a problem? + placeholder: Please, tell us a clear and concise description of the feature. + validations: + required: true + - type: markdown + attributes: + value: | + ## Desired Solution + - type: textarea + id: desired-solution + attributes: + label: Describe the solution you would like + description: | + Please explain: + - How you expect the feature would work. + - What is the expected output/behavior for this feature. + - What you think that shouldn't be done. + placeholder: Please, tell us what did you expect to happen, what's the intended behavior. + validations: + required: true + - type: textarea + id: solution-alternatives + attributes: + label: Describe alternatives solutions you would have considered + description: | + Please explain: + - If there are any any alternative solutions tha might work. + - If there is any workaround for the problem. + - Why this alternatives aren't satisfactory? + validations: + required: false + - type: markdown + attributes: + value: | + ## Suggestions + - type: textarea + id: source-code-example + attributes: + label: Source Code Examples + description: | + Whenever relevant, please provide a code sample, of what would be the syntax, the way you meant to use. + This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + - type: markdown + attributes: + value: | + ## Additional context + - type: textarea + id: other-notes + attributes: + label: Additional Notes + description: Anything not covered or N/A + placeholder: n/a + validations: + required: false + - type: checkboxes + id: agree-to-code-of-conduct + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow the project [Code of Conduct](https://github.com/petl-developers/petl/blob/master/CODE_OF_CONDUCT.md). + options: + - label: I agree to follow this project's Code of Conduct + required: true