summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClementTsang <cjhtsang@uwaterloo.ca>2020-09-18 01:55:19 -0400
committerClementTsang <cjhtsang@uwaterloo.ca>2020-09-18 01:55:19 -0400
commit83445eccbb37b5261e98eef0a7f1bfdbab776337 (patch)
tree2939064362cdfcdd07ab8d5d513bdd1d28dbebd9
parent86c8b474aeea2c64d556d2ac989a825719038aaf (diff)
other: update github issue templates
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md32
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md4
-rw-r--r--.github/ISSUE_TEMPLATE/question_template.md2
3 files changed, 17 insertions, 21 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 38aadecd..878d63f9 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,38 +6,34 @@ labels: "bug"
assignees: ""
---
-## Describe the bug
+### Describe the bug
-_A clear and concise description of what the bug is and what the expected behaviour was. If applicable, add screenshots to help explain your problem:_
+_A clear and concise description of what the bug is and what the expected behaviour was._
+_If applicable, add screenshots to help explain your problem:_
-## To reproduce
+### To reproduce
_Steps on how to reproduce the behaviour:_
1. Go to...
-2. See error
+2. Click on...
+3. See error
-## Platform
+### bottom version (use `btm -V`)
-_If relevant, please provide information on:_
-
-**Operating System and Version:**
-
-**Terminal:**
+### bottom config file (if one is used)
-**Shell:**
+### Platform
-**System Info:**
-
-_Information about your system specifically (sometimes this matters...):_
+_If relevant, please provide information on:_
-- _Total RAM:_
+**Operating system and OS version:**
-- _Total SWAP:_
+**Terminal (i.e. urxvt, kitty, etc.):**
-- _CPU:_
+**Shell (i.e. zsh, bash, etc.):**
-**bottom version (use `btm -V`):**
+**System info (RAM, SWAP, etc.):**
**Rust version (if building yourself):**
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 31cc7191..29d04641 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -6,10 +6,10 @@ labels: "feature"
assignees: ""
---
-## Describe the feature request
+### Describe the feature request
_Why should we consider this feature request? Describe why, and/or how you think this feature will solve the issue, or overall improve the application:_
-## Additional context/details
+### Additional context/details
_Provide any additional context or details here. What needs to be done, why, etc:_
diff --git a/.github/ISSUE_TEMPLATE/question_template.md b/.github/ISSUE_TEMPLATE/question_template.md
index 70ea51dc..a941798a 100644
--- a/.github/ISSUE_TEMPLATE/question_template.md
+++ b/.github/ISSUE_TEMPLATE/question_template.md
@@ -6,4 +6,4 @@ labels: "question"
assignees: ""
---
-## Question
+### Question