Skip to content

Commit

Permalink
Initial ISSUES_TEMPLATE
Browse files Browse the repository at this point in the history
* Adopting a similar system to *@octokit/octokit*
* Since this needs to be spelled out... spelling it out.
* Embedded Unicode is prohibited *(is anyhow in STYLEGUIDE.md) in these files as a potential crash of git-scm can occur on some systems.
* GH discussions are still in Beta but used "Community-driven" for OUJS vs whatever nomenclature we use if we turn that feature on.

Applies to OpenUserJS#249 OpenUserJS#1792

Ref(s):
* https://yaml.org/spec/spec.html
* https://bugs.launchpad.net/ubuntu/+source/git/+bug/1852985#yui_3_10_3_1_1619665759075_313
  • Loading branch information
Martii committed Apr 29, 2021
1 parent d4a9ab2 commit cace20a
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/01_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---

name: "Feature request"
about: >
Something we **DO NOT** already have implemented to the best of your knowledge but you would like to see.
(NOTE: Please search existing issues and milestones first.).
labels: feature

---

<!-- Please replace all placeholders such as this below -->

**What’s missing?**

<!-- Describe your feature idea -->

**Why?**

<!-- Describe the problem you are facing -->

**Alternatives you tried**

<!-- Describe the workarounds you tried so far and how they worked for you -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/02_enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---

name: "Enhancement request"
about: >
Something we **DO** have implemented already but needs improvement upon to the best of your knowledge.
(NOTE: Please search existing issues and milestones first.).
labels: enhancement

---

<!-- Please replace all placeholders such as this below -->

**What’s missing?**

<!-- Describe your feature idea -->

**Why?**

<!-- Describe the problem you are facing -->

**Alternatives you tried**

<!-- Describe the workarounds you tried so far and how they worked for you -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/03_possible_bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---

name: "Bug Investigation"
about: >
If something isn't working as expected.
(NOTES: Status codes below 500 are usually a user error and not a server error. i.e. Usually not a bug. Please search existing issues and milestones first.).
labels: bug

---

<!-- Please replace all placeholders such as this below -->

**What happened?**

<!-- Describe the problem and how to reproduce it. Add screenshots or a link to your repository if helpful. -->

**What did you expect to happen?**

<!-- Describe what you expected to happen instead -->

**What the problem might be**

<!-- If you have an idea where the bug might lie, please share here. Otherwise remove the whole section -->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Community-driven help
url: https://openuserjs.org/discuss
about: Do you have a question? Start here.

0 comments on commit cace20a

Please sign in to comment.