Skip to content

Commit

Permalink
Add issue template for the template
Browse files Browse the repository at this point in the history
  • Loading branch information
paddyroddy committed Jan 23, 2024
1 parent 69b352d commit 499a262
Show file tree
Hide file tree
Showing 6 changed files with 165 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATES/question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
blank_issues_enabled: false
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?
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 {{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATES/question.yml
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

0 comments on commit 499a262

Please sign in to comment.