Skip to content

Commit

Permalink
chore: add Github issue form templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rudokotrla committed Apr 9, 2024
1 parent c312a5a commit d414f92
Show file tree
Hide file tree
Showing 4 changed files with 120 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Bug Report
description: File a bug report
title: "bug: "
labels: ["bug"]
body:
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: steps-reproduce
attributes:
label: Steps to reproduce
description: Please provide the steps that lead to the buggy behaviour.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Please provide additional context e.g. logs
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Documentation
description: Propose change to the documentation
title: "docs: "
labels: ["documentation"]
body:
- type: textarea
id: proposed-change
attributes:
label: Proposed change
description: Describe the proposed change or addition to the documentation
placeholder: e.g. "Write concise contribution guidelines"
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: File a new feature request
title: "feat: "
labels: ["enhancement"]
body:
- type: textarea
id: reason
attributes:
label: Reason for feature
description: Describe the reason or motivation behind the feature request
placeholder: e.g. "I cannot accomplish ... because ..."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed solution
description: Describe your proposed solution / idea of the feature.
placeholder: e.g. "Add a new button that ..."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives / Available workarounds
description: A clear and concise description of any alternative solutions or workarounds you've considered.
placeholder: e.g. "I can currently work around this by ..." or "No alternatives found."
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Anything else that is important to know?
validations:
required: false
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Question
description: Ask a question about this project
title: "question: "
labels: ["question"]
body:
- type: textarea
id: question
attributes:
label: Your question
description: Ask your question here.
placeholder: e.g. "How can I accomplish ...?"
validations:
required: true
- type: dropdown
id: scope
attributes:
multiple: true
label: Scope
options:
- Aim of the project
- Documentation
- Project setup
- Codebase
description: Specify the feature or part of the project your question is about
- type: input
id: scope-not-listed
attributes:
label: Additional scope
description: If the scope is not listed, please specify it here
required: false

0 comments on commit d414f92

Please sign in to comment.