From a3ab809515ed38dbdd017028dcfe0abb8a3bfcbb Mon Sep 17 00:00:00 2001 From: Ossama Hjaji Date: Sun, 15 May 2022 22:09:03 +0200 Subject: [PATCH] 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 * add duplicate section to bug report issue form * fix typo * fix typo Co-authored-by: Spenser Black --- .github/ISSUE_TEMPLATE/bug_report.md | 19 ------------- .github/ISSUE_TEMPLATE/bug_report.yml | 33 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 --------------- .github/ISSUE_TEMPLATE/feature_request.yml | 17 +++++++++++ .github/ISSUE_TEMPLATE/new_language.md | 22 --------------- .github/ISSUE_TEMPLATE/new_language.yml | 24 ++++++++++++++++ 6 files changed, 74 insertions(+), 64 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/new_language.md create mode 100644 .github/ISSUE_TEMPLATE/new_language.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a4a18e2f..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Bug Report -about: Report a bug or unexpected behavior -title: '' -labels: 'Bug' - ---- - -### Expected Behavior - - - -### Actual behavior - - - -### Minimal Steps to Reproduce - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..7445b66a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 4b25d864..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -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 - - - -### Describe the solution you'd like - - - -### Describe alternatives you've considered - - - -### Additional context - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..dda6e249 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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? diff --git a/.github/ISSUE_TEMPLATE/new_language.md b/.github/ISSUE_TEMPLATE/new_language.md deleted file mode 100644 index 30a98fb3..00000000 --- a/.github/ISSUE_TEMPLATE/new_language.md +++ /dev/null @@ -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\] - - - -### Logo - - - -### Upstream support - - -- [ ] [tokei] supports this language - -[tokei]: https://github.com/XAMPPRocky/tokei diff --git a/.github/ISSUE_TEMPLATE/new_language.yml b/.github/ISSUE_TEMPLATE/new_language.yml new file mode 100644 index 00000000..e19ef096 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_language.yml @@ -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