Browse Source

Add github issue forms (#667)

* add bug report issue form

* add feature request issue form

* simple text description

* new language request issue form

* fix checkbox text

* wrap lines

Co-authored-by: Spenser Black <spenserblack01@gmail.com>

* add duplicate section to bug report issue form

* fix typo

* fix typo

Co-authored-by: Spenser Black <spenserblack01@gmail.com>
pull/669/head
Ossama Hjaji 4 years ago committed by GitHub
parent
commit
a3ab809515
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 19
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 33
      .github/ISSUE_TEMPLATE/bug_report.yml
  3. 23
      .github/ISSUE_TEMPLATE/feature_request.md
  4. 17
      .github/ISSUE_TEMPLATE/feature_request.yml
  5. 22
      .github/ISSUE_TEMPLATE/new_language.md
  6. 24
      .github/ISSUE_TEMPLATE/new_language.yml

19
.github/ISSUE_TEMPLATE/bug_report.md

@ -1,19 +0,0 @@ @@ -1,19 +0,0 @@
---
name: Bug Report
about: Report a bug or unexpected behavior
title: ''
labels: 'Bug'
---
### Expected Behavior
<!-- Please describe what should have happened -->
### Actual behavior
<!-- Please describe what actually happened -->
### Minimal Steps to Reproduce
<!-- Please describe how we can reproduce this bug -->

33
.github/ISSUE_TEMPLATE/bug_report.yml

@ -0,0 +1,33 @@ @@ -0,0 +1,33 @@
name: Bug report 🐛
description: Create a bug report to help us improve
labels: ["bug"]
body:
- type: markdown
attributes:
value: Thanks for contributing by creating an issue! ❤
- type: checkboxes
attributes:
label: Duplicates
description: |
Please [search the history](https://github.com/o2sh/onefetch/issues) to see if an issue already exists for the same problem.
📌 If your issue refers to an incorrect language detection, please have a look [here](https://github.com/o2sh/onefetch/issues/26).
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current behavior 😯
description: Describe what happens instead of the expected behavior.
- type: textarea
attributes:
label: Expected behavior 🤔
description: Describe what should happen.
- type: textarea
attributes:
label: Steps to reproduce 🕹
description: Describe how we can reproduce this bug.
placeholder: |
1.
2.
3.

23
.github/ISSUE_TEMPLATE/feature_request.md

@ -1,23 +0,0 @@ @@ -1,23 +0,0 @@
---
name: Feature request
about: Suggest an improvement
title: ''
labels: 'feature request'
---
### 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. -->

17
.github/ISSUE_TEMPLATE/feature_request.yml

@ -0,0 +1,17 @@ @@ -0,0 +1,17 @@
name: Feature request 💄
description: Suggest an improvement
labels: ["feature request"]
body:
- type: markdown
attributes:
value: Thanks for contributing by creating an issue! ❤
- type: textarea
attributes:
label: Summary 💡
description: Describe how it should work.
- type: textarea
attributes:
label: Motivation 🔦
description: >
What are you trying to accomplish?
How has the lack of this feature affected you?

22
.github/ISSUE_TEMPLATE/new_language.md

@ -1,22 +0,0 @@ @@ -1,22 +0,0 @@
---
name: New Language Request
about: Request for a new language to be supported
title: 'New Language Request: [LANGUAGE]'
labels: 'enhancement, good first issue'
---
### \[Language Name\]
<!-- Please provide the name of the language and any additional details that we should know -->
### Logo
<!-- Is there a logo that can be used as a source of inspiration for the ASCII art? -->
### Upstream support
<!-- Onefetch relies on tokei for language detection. Does tokei already support the language in question? -->
- [ ] [tokei] supports this language
[tokei]: https://github.com/XAMPPRocky/tokei

24
.github/ISSUE_TEMPLATE/new_language.yml

@ -0,0 +1,24 @@ @@ -0,0 +1,24 @@
name: New Language Request 📢
description: Request for a new language to be supported
labels: ["enhancement, good first issue"]
body:
- type: markdown
attributes:
value: Thanks for contributing by creating an issue! ❤
- type: textarea
attributes:
label: Language Name 🖊
description: Provide the name of the language and any additional details that we should know.
- type: textarea
attributes:
label: Logo 📷
description: Is there a logo that can be used as a source of inspiration for the ASCII art?
- type: checkboxes
attributes:
label: Upstream support ✅
description: |
Onefetch relies on [tokei](https://github.com/XAMPPRocky/tokei) for language detection.
options:
- label: Does tokei already support the language in question?
required: true
Loading…
Cancel
Save