Skip to content

Commit

Permalink
Issue templates (#2242)
Browse files Browse the repository at this point in the history
* add issue templates

* add pull request template
  • Loading branch information
DjordyKoert committed Mar 11, 2024
1 parent d8a8d8f commit 7bc02c7
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/1_Bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]

body:
- type: input
id: version
attributes:
label: Version
description: What version are you running?
placeholder: x.y.z
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the problem
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context about the bug (configs, logs, screenshots etc.)
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/2_Question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Question
description: Ask a question
title: "[Question]: "
labels: ["question"]

body:
- type: input
id: version
attributes:
label: Version
description: What version are you running?
placeholder: x.y.z
validations:
required: true
- type: textarea
id: question
attributes:
label: Question
description: Please tell us about your question or problem
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context (configs, logs, screenshots etc.)
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/3_Feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Feature Request
description: Suggest ideas for new features and improvements
title: "[Feature]: "
labels: ["enhancement"]

body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the feature
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context about the feature request (e.g. screenshots, code snippets, etc.)
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
| Q | A |
|---------------|---------------------------------------------------------------------------------------------------------------------------|
| Bug fix? | yes/no |
| New feature? | yes/no <!-- please update src/**/CHANGELOG.md files --> |
| Deprecations? | yes/no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> |
| Issues | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exists, explain below instead --> |

<!--
Replace this notice by a description of your feature/bugfix.
This will help reviewers and should be a good start for the documentation.
Additionally:
- Always add tests and ensure they pass.
- For new features, provide some code snippets to help understand usage.
-->

0 comments on commit 7bc02c7

Please sign in to comment.