Skip to content

Commit

Permalink
Add issue templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
charleskorn committed Sep 4, 2021
1 parent 0936c85 commit dbc3791
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Bug report
description: Report an issue in kaml
labels:
- is:bug
body:
- type: textarea
attributes:
label: Describe the bug
description: Describe the problem in a few sentences. Please include exact error messages (if any).
validations:
required: true
- type: textarea
attributes:
label: Reproduction repo
description: While not required, if you can provide a simple sample project that demonstrates the problem, this makes it much easier to understand and investigate the issue and validate that it has been fixed.
validations:
required: false
- type: textarea
attributes:
label: Steps to reproduce
description: A clear set of steps that triggers the issue.
validations:
required: true
- type: textarea
attributes:
label: Expected behaviour
description: A description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual behaviour
description: A description of what actually happened. Include any error messages and other surrounding output.
validations:
required: true
- type: textarea
attributes:
label: Version information
description: What version of kaml are you using? (Now is also a good time to double-check you're using the [most recent version](https://github.com/charleskorn/kaml/releases/latest) of kaml.)
render: plain text
validations:
required: true
- type: textarea
attributes:
label: Any other information
description: Is there anything else we need to know?
validations:
required: false
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false

contact_links:
- name: Questions
about: Have a question about kaml? Discussions is the best place for that.
url: https://github.com/charleskorn/kaml/discussions
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest an idea for kaml
labels:
- is:suggestion
body:
- type: textarea
attributes:
label: Describe the problem you'd like to solve
description: A clear and concise description of what the problem is. For example, [...] is really time consuming and error prone.
validations:
required: true
- 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
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Add any other context about the feature request here.
validations:
required: false

0 comments on commit dbc3791

Please sign in to comment.