Skip to content

Commit

Permalink
More verbose bug report template, added config.yml with links to Slac…
Browse files Browse the repository at this point in the history
…k/docs + disabled blank issues, added feature request template
  • Loading branch information
moritzheiber committed May 26, 2020
1 parent a5bcd32 commit 0ff27a7
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 2 deletions.
11 changes: 9 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
name: Bug report
about: Create a report to help us improve
about: Create a report to help us improve Regolith
title: ''
labels: ''
labels: bug, needs-triage
assignees: ''

---

- [ ] I've [run a search on the existing bug reports](https://help.github.com/en/github/searching-for-information-on-github/searching-issues-and-pull-requests) to make sure I'm not filing a duplicate (you can use the search box at the top left corner)
- [ ] I've read [the Regolith documentation](https://regolith-linux.org/docs/https://regolith-linux.org/docs/) and didn't find any relevant topic
- [ ] I tried [asking on Slack](https://regolith-linux.org/interact/) (especially for configuration related issues)

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

Expand All @@ -19,6 +23,9 @@ A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.

**Configuration file(s)**
Please attach or mention any customization you've done to configuration files which might have an impact on the bug you are describing. It'll help us determine the root cause of your issue.

**Installation Details**
- Regolith Install Type: [ISO/PPA]
- Regolith Version: [e.g. 1.4]
Expand Down
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Regolith Documentation
url: https://regolith-linux.org/docs/
about: The Regolith documentation has answers to a lot questions, especially about customization. Please read it before opening an issue.
- name: Regolith Slack
url: https://regolith-linux.herokuapp.com/
about: The Regolith Slack lets you connect with fellow users and the developers. Use it to ask questions and suggest features.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an enhancement for this project
title: ''
labels: enhancement, needs-triage
assignees: ''

---

- [ ] I've [run a search on the existing enhancements](https://help.github.com/en/github/searching-for-information-on-github/searching-issues-and-pull-requests) to make sure I'm not filing a duplicate (you can use the search box at the top left corner)
- [ ] I've read [the Regolith documentation](https://regolith-linux.org/docs/https://regolith-linux.org/docs/) and didn't find any relevant topic
- [ ] I tried [asking on Slack](https://regolith-linux.org/interact/) (especially for configuration related issues)

**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 0ff27a7

Please sign in to comment.