Skip to content

Commit

Permalink
feat: Add issue templates (#68)
Browse files Browse the repository at this point in the history
* feat: Add issue templates

These are the suggested templates from GitHub.

* feat: Auto-format templates

* docs: Set default issue template title and labels

* docs: Remove irrelevant sections

* docs: Use placeholders for text to be removed

* docs: Add section for actual behaviour
  • Loading branch information
l0b0 authored Sep 29, 2021
1 parent e9d0ec3 commit bdd3c14
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: 'Bug: '
labels: 'bug'
assignees: ''
---

[Please remove this and other [placeholder text] before submitting.]

**Describe the bug**
[A clear and concise description of what the bug is.]

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
[A clear and concise description of what you expected to happen.]

**Actual behavior**
[Describe what actually happened.]

[If applicable, add logs to help explain your problem:]

```console
[Paste logs here]
```

**Additional context**
[Add any other context about the problem here.]
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'Feature request: '
labels: 'enhancement'
assignees: ''
---

[Please remove this and other [placeholder text]] before submitting.

**Is your feature request related to a problem? Please describe.**
[A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]]

**Describe the solution you'd like**
[A clear and concise description of what you want to happen.]

**Describe alternatives you've considered**
[A clear and concise description of any alternative solutions or features you've considered.]

**Additional context**
[Add any other context or screenshots about the feature request here.]

0 comments on commit bdd3c14

Please sign in to comment.