Skip to content

Commit

Permalink
Add GitHub issue templates
Browse files Browse the repository at this point in the history
Part of #6.
  • Loading branch information
davidclemens committed Dec 29, 2020
1 parent d645a9e commit 38dd20a
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 0 deletions.
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: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: 'Issue: 📚 Documentation'
about: 'You came across parts of the documentation that should be fixed'
title: ''
labels: documentation
assignees: ''

---

<!--
Thanks for reporting an issue in the documentation.
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

## Where to find the issue
<!-- Be as specific as possible by naming the document, page, and ideally paragraph. -->

## Describe the issue
<!-- Please let us know what exactly is the issue with that part of the documentation -->

## Suggested change
<!-- If you have ideas on how to fix this issue, please note them here, or consider creating a Pull Request -->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: 'Issue: 🛠 Enhancement Request'
about: 'You have an idea for an enhancement'
title: ''
labels: enhancement
assignees: ''

---

<!--
Thanks for proposing an enhancement.
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

## Current Implementation
<!-- Describe or point to the current implementation that you would like to see improved -->

## Suggested Enhancement
<!-- Outline the idea of your enhancement, by e.g., describing the algorithm you propose. -->

## Expected Benefits
<!-- Summarize how your enhancement could aid the project (performance, readability, usability, etc.). -->

## Is this something you're interested in working on
<!--- Yes or No -->
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: 'Issue: 🎁 Feature Request'
about: 'You have an idea for a new feature'
title: ''
labels: new feature
assignees: ''

---

<!--
Thanks for requesting a feature.
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

## Feature description
<!---
Provide a detailed description of the feature or improvement you are proposing. What specific solution would you like? What is the expected behaviour?
Add any other context, screenshots, or code snippets about the feature request here as well.
-->

## Problem and motivation
<!---
Why is this change important to you? What is the problem this feature would solve? How would you use it?
-->

## Is this something you're interested in working on
<!--- Yes or No -->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: 'Issue: 💬 Anything else?'
about: 'You have some other issue to raise'
title: ''
labels:
assignees: ''

---

<!--
Thanks for contributing to the project.
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

* [ ] None of the other issue templates apply to this issue.

0 comments on commit 38dd20a

Please sign in to comment.