From 69b352d36b63dba9d18a3f927ca516ee66b3574d Mon Sep 17 00:00:00 2001 From: "Patrick J. Roddy" Date: Tue, 23 Jan 2024 11:06:58 +0000 Subject: [PATCH 1/2] Add issue templates to this project --- .github/ISSUE_TEMPLATES/bug_report.yml | 62 +++++++++++++++++++++ .github/ISSUE_TEMPLATES/config.yml | 2 + .github/ISSUE_TEMPLATES/documentation.yml | 31 +++++++++++ .github/ISSUE_TEMPLATES/feature_request.yml | 38 +++++++++++++ .github/ISSUE_TEMPLATES/question.yml | 28 ++++++++++ .github/ISSUE_TEMPLATES/website.yml | 31 +++++++++++ 6 files changed, 192 insertions(+) create mode 100644 .github/ISSUE_TEMPLATES/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATES/config.yml create mode 100644 .github/ISSUE_TEMPLATES/documentation.yml create mode 100644 .github/ISSUE_TEMPLATES/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATES/question.yml create mode 100644 .github/ISSUE_TEMPLATES/website.yml diff --git a/.github/ISSUE_TEMPLATES/bug_report.yml b/.github/ISSUE_TEMPLATES/bug_report.yml new file mode 100644 index 00000000..9c74b2cf --- /dev/null +++ b/.github/ISSUE_TEMPLATES/bug_report.yml @@ -0,0 +1,62 @@ +--- +name: Bug Report +description: Create a Report to Help us Improve +title: "[BUG]: " +labels: + - bug +assignees: + - paddyroddy + - samcunliffe +body: + - id: describe + type: textarea + attributes: + label: Describe the Bug + description: A clear and concise description of what the bug is. + validations: + required: true + - id: reproduce + type: textarea + attributes: + label: To Reproduce + description: >- + A minimal working example of code to reproduce the unexpected behaviour. + validations: + required: true + - id: expected + type: textarea + attributes: + label: Expected Behaviour + description: >- + A clear and concise description of what you expected to happen. + validations: + required: true + - id: actual + type: textarea + attributes: + label: Actual Behaviour + description: >- + Be a specific and detailed as you can. + Paste any output or stack traces of errors you receive. + validations: + required: true + # - id: version + # type: input + # attributes: + # label: Version In Use + # description: |- + # Can be found by + # ```sh + # python -c "import sleplet; print(sleplet.__version__)" + # ``` + # validations: + # required: true + - id: additional + type: textarea + attributes: + label: Additional Context + value: |- + - Cookiecutter version: + - Operating system: + - Python version: + render: markdown diff --git a/.github/ISSUE_TEMPLATES/config.yml b/.github/ISSUE_TEMPLATES/config.yml new file mode 100644 index 00000000..bd9dfe4e --- /dev/null +++ b/.github/ISSUE_TEMPLATES/config.yml @@ -0,0 +1,2 @@ +--- +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATES/documentation.yml b/.github/ISSUE_TEMPLATES/documentation.yml new file mode 100644 index 00000000..03177322 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/documentation.yml @@ -0,0 +1,31 @@ +--- +name: Documentation +description: How Can We Improve the Documentation +title: "[DOCS]: " +labels: + - documentation +assignees: + - paddyroddy + - samcunliffe +body: + - id: section + type: textarea + attributes: + label: Which Section of the Documentation Needs Improving? + description: Please provide a link (if it is a specific page). + validations: + required: true + - id: problem + type: textarea + attributes: + label: What Can be Improved About This Section + description: Is it incomplete, incorrect or difficult to understand? + validations: + required: true + - id: suggestions + type: textarea + attributes: + label: How to Improve This Section + description: >- + Do you have any specific suggestions we + could take to improve the documentation? diff --git a/.github/ISSUE_TEMPLATES/feature_request.yml b/.github/ISSUE_TEMPLATES/feature_request.yml new file mode 100644 index 00000000..09b87b25 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/feature_request.yml @@ -0,0 +1,38 @@ +--- +name: Feature Request +description: Suggest a Way to Improve This Project +title: "[FEATURE]: " +labels: + - enhancement +assignees: + - paddyroddy + - samcunliffe +body: + - id: problem + type: textarea + attributes: + label: Is Your Feature Request Related to a Problem? Please Describe + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + validations: + required: true + - id: solution + type: textarea + attributes: + label: Describe the Solution You'd Like + description: A clear and concise description of what you want to happen. + validations: + required: true + - id: alternatives + type: textarea + attributes: + label: Describe Alternatives You've Considered + description: >- + A clear and concise description of any alternative + solutions or features you've considered. + - id: additional + type: textarea + attributes: + label: Additional Context + description: >- + Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATES/question.yml b/.github/ISSUE_TEMPLATES/question.yml new file mode 100644 index 00000000..1bbb2b9d --- /dev/null +++ b/.github/ISSUE_TEMPLATES/question.yml @@ -0,0 +1,28 @@ +--- +name: Question +description: General Questions About Using the Cookiecutter Template +title: "[QUESTION]: " +labels: + - question +assignees: + - paddyroddy + - samcunliffe +body: + - id: topic + type: dropdown + attributes: + label: What is the Topic of Your Question + description: Please indicate the topic in the title of your question. + options: + - Installation + - Usage + - Documentation + - Other + validations: + required: true + - id: question + type: textarea + attributes: + label: Add Your Question Below + validations: + required: true diff --git a/.github/ISSUE_TEMPLATES/website.yml b/.github/ISSUE_TEMPLATES/website.yml new file mode 100644 index 00000000..5411578e --- /dev/null +++ b/.github/ISSUE_TEMPLATES/website.yml @@ -0,0 +1,31 @@ +--- +name: Website +description: How Can We Improve the Website +title: "[WEBSITE]: " +labels: + - website +assignees: + - paddyroddy + - samcunliffe +body: + - id: section + type: textarea + attributes: + label: Which Section of the Website Needs Improving? + description: Please provide a link (if it is a specific page). + validations: + required: true + - id: problem + type: textarea + attributes: + label: What Can be Improved About This Section + description: Is it incomplete, incorrect or difficult to understand? + validations: + required: true + - id: suggestions + type: textarea + attributes: + label: How to Improve This Section + description: >- + Do you have any specific suggestions we + could take to improve the website? From 499a262234cd64f93bbd8f015bc14e021edd24d4 Mon Sep 17 00:00:00 2001 From: "Patrick J. Roddy" Date: Tue, 23 Jan 2024 11:21:58 +0000 Subject: [PATCH 2/2] Add issue template for the template --- .github/ISSUE_TEMPLATES/question.yml | 3 +- .../.github/ISSUE_TEMPLATES/bug_report.yml | 67 +++++++++++++++++++ .../.github/ISSUE_TEMPLATES/config.yml | 2 + .../.github/ISSUE_TEMPLATES/documentation.yml | 30 +++++++++ .../ISSUE_TEMPLATES/feature_request.yml | 37 ++++++++++ .../.github/ISSUE_TEMPLATES/question.yml | 27 ++++++++ 6 files changed, 165 insertions(+), 1 deletion(-) create mode 100644 {{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/bug_report.yml create mode 100644 {{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/config.yml create mode 100644 {{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/documentation.yml create mode 100644 {{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/feature_request.yml create mode 100644 {{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/question.yml diff --git a/.github/ISSUE_TEMPLATES/question.yml b/.github/ISSUE_TEMPLATES/question.yml index 1bbb2b9d..038bf553 100644 --- a/.github/ISSUE_TEMPLATES/question.yml +++ b/.github/ISSUE_TEMPLATES/question.yml @@ -14,9 +14,10 @@ body: label: What is the Topic of Your Question description: Please indicate the topic in the title of your question. options: + - Documentation - Installation - Usage - - Documentation + - Website - Other validations: required: true diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/bug_report.yml b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/bug_report.yml new file mode 100644 index 00000000..f737b35d --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/bug_report.yml @@ -0,0 +1,67 @@ +--- +name: Bug Report +description: Create a Report to Help us Improve +title: "[BUG]: " +labels: + - bug +assignees: + - "{{cookiecutter.github_username}}" +body: + - id: describe + type: textarea + attributes: + label: Describe the Bug + description: A clear and concise description of what the bug is. + validations: + required: true + - id: reproduce + type: textarea + attributes: + label: To Reproduce + description: >- + A minimal working example of code to reproduce the unexpected behaviour, + this will render as `Python` code so no need for backticks. + value: |- + import {{cookiecutter.package_name}} + + ... + render: python + validations: + required: true + - id: expected + type: textarea + attributes: + label: Expected Behaviour + description: >- + A clear and concise description of what you expected to happen. + validations: + required: true + - id: actual + type: textarea + attributes: + label: Actual Behaviour + description: >- + Be a specific and detailed as you can. + Paste any output or stack traces of errors you receive. + validations: + required: true + - id: version + type: input + attributes: + label: Version In Use + description: |- + Can be found by + ```sh + python -c "import {{cookiecutter.package_name}}; + print({{cookiecutter.package_name}}.__version__)" + ``` + validations: + required: true + - id: additional + type: textarea + attributes: + label: Additional Context + value: |- + - Python version: + - Operating system: + render: markdown diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/config.yml b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/config.yml new file mode 100644 index 00000000..bd9dfe4e --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/config.yml @@ -0,0 +1,2 @@ +--- +blank_issues_enabled: false diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/documentation.yml b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/documentation.yml new file mode 100644 index 00000000..b755393e --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/documentation.yml @@ -0,0 +1,30 @@ +--- +name: Documentation +description: How Can We Improve the Documentation +title: "[DOCS]: " +labels: + - documentation +assignees: + - "{{cookiecutter.github_username}}" +body: + - id: section + type: textarea + attributes: + label: Which Section of the Documentation Needs Improving? + description: Please provide a link (if it is a specific page). + validations: + required: true + - id: problem + type: textarea + attributes: + label: What Can be Improved About This Section + description: Is it incomplete, incorrect or difficult to understand? + validations: + required: true + - id: suggestions + type: textarea + attributes: + label: How to Improve This Section + description: >- + Do you have any specific suggestions we + could take to improve the documentation? diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/feature_request.yml b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/feature_request.yml new file mode 100644 index 00000000..1c8211c8 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/feature_request.yml @@ -0,0 +1,37 @@ +--- +name: Feature Request +description: Suggest a Way to Improve This Project +title: "[FEATURE]: " +labels: + - enhancement +assignees: + - "{{cookiecutter.github_username}}" +body: + - id: problem + type: textarea + attributes: + label: Is Your Feature Request Related to a Problem? Please Describe + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + validations: + required: true + - id: solution + type: textarea + attributes: + label: Describe the Solution You'd Like + description: A clear and concise description of what you want to happen. + validations: + required: true + - id: alternatives + type: textarea + attributes: + label: Describe Alternatives You've Considered + description: >- + A clear and concise description of any alternative + solutions or features you've considered. + - id: additional + type: textarea + attributes: + label: Additional Context + description: >- + Add any other context or screenshots about the feature request here. diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/question.yml b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/question.yml new file mode 100644 index 00000000..93e82a4a --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/question.yml @@ -0,0 +1,27 @@ +--- +name: Question +description: General Questions About Using {{cookiecutter.project_name}} +title: "[QUESTION]: " +labels: + - question +assignees: + - "{{cookiecutter.github_username}}" +body: + - id: topic + type: dropdown + attributes: + label: What is the Topic of Your Question + description: Please indicate the topic in the title of your question. + options: + - Documentation + - Installation + - Usage + - Other + validations: + required: true + - id: question + type: textarea + attributes: + label: Add Your Question Below + validations: + required: true