-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into smg/community-edits
- Loading branch information
Showing
11 changed files
with
356 additions
and
0 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,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 |
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,2 @@ | ||
| --- | ||
| blank_issues_enabled: 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,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? |
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,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. |
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,29 @@ | ||
| --- | ||
| 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: | ||
| - Documentation | ||
| - Installation | ||
| - Usage | ||
| - Website | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - id: question | ||
| type: textarea | ||
| attributes: | ||
| label: Add Your Question Below | ||
| validations: | ||
| 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,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? |
67 changes: 67 additions & 0 deletions
67
{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/bug_report.yml
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,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 |
2 changes: 2 additions & 0 deletions
2
{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/config.yml
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,2 @@ | ||
| --- | ||
| blank_issues_enabled: false |
30 changes: 30 additions & 0 deletions
30
{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/documentation.yml
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,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? |
37 changes: 37 additions & 0 deletions
37
{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/feature_request.yml
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,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. |
27 changes: 27 additions & 0 deletions
27
{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/question.yml
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,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 |