Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

Commit 58232aa

Browse files
pellizzettipellizzetti
authored
chore: Add issue templates
Without templates, sometimes the issue author can forget to add essential information to the resolution, not only that but issues can also be described in different words and formats each time, which makes them more difficult to standardize. It’s hard to solve a problem when important details are missing and every issue is diferrent. This change add issue templates to help contributors share the right details at the start of a thread and keep things consistent.
1 parent 110e65a commit 58232aa

5 files changed

Lines changed: 123 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks! -->
11+
12+
<!-- Verify first that your issue is not already reported -->
13+
14+
<!-- If possible complete *all* sections as described -->
15+
16+
**Describe the bug**
17+
18+
<!-- A clear and concise description of what the bug is. -->
19+
20+
**To Reproduce**
21+
22+
<!--
23+
Steps to reproduce the behavior:
24+
1. Go to '...'
25+
2. Click on '....'
26+
3. Scroll down to '....'
27+
4. See error
28+
-->
29+
30+
**Expected behavior**
31+
32+
<!-- A clear and concise description of what you expected to happen. -->
33+
34+
**Exception or Error**
35+
36+
<pre><code>
37+
<!-- If the issue is accompanied by an exception or an error, please share it below: -->
38+
<!-- ✍️-->
39+
</code></pre>
40+
41+
**Screenshots**
42+
43+
<!-- If applicable, add screenshots to help explain your problem. -->
44+
45+
**Environment:**
46+
47+
<!--
48+
Add information about your environment
49+
- OS: [e.g. iOS, Ubuntu]
50+
- Browser [e.g. Chrome (69.0.3472.3), Firefox (62.0.3)]
51+
- Node [e.g 8.9.1]
52+
- Etc
53+
-->
54+
55+
**Additional context**
56+
57+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/d.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: d
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+

‎.github/ISSUE_TEMPLATE/documentation-report.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Documentation report
3+
about: Use this template for documentation related issues
4+
title: ''
5+
labels: docs
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Verify first that your issue is not already reported -->
11+
12+
<!-- Please only use this template for documentation related issues -->
13+
14+
<!-- If possible complete *all* sections as described -->
15+
16+
**Description of issue**
17+
18+
<!-- Give a clear description what needs changing, why should it be changed? How is it useful? -->
19+
20+
**Usage example**
21+
22+
<!-- Is there a usage example? -->

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Documentation
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+

‎.github/ISSUE_TEMPLATE/enhancement-request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Enhancement request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Verify first that your issue is not already reported -->
11+
12+
<!-- Please only use this template for submitting enhancement requests -->
13+
14+
<!-- If possible complete *all* sections as described -->
15+
16+
**What would you like to be added**:
17+
18+
**Why is this needed**:
19+
20+
**Is your enhancement request related to a problem? Please describe.**
21+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
22+
23+
**Additional context**
24+
<!-- Add any other context or screenshots about the feature request here. -->

0 commit comments

Comments
 (0)