From 5bb4271edbc2e0bb53b43db7e74fd71625d7f291 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Mon, 13 Jun 2022 14:33:26 +0200 Subject: [PATCH] Add form template for issue templates --- .github/ISSUE_TEMPLATE/00-bug-issue.md | 36 ---------------- .github/ISSUE_TEMPLATE/00-bug-issue.yml | 43 +++++++++++++++++++ .../ISSUE_TEMPLATE/10-installation-issue.md | 31 ------------- .../ISSUE_TEMPLATE/10-installation-issue.yml | 39 +++++++++++++++++ .../ISSUE_TEMPLATE/20-documentation-issue.md | 29 ------------- .../ISSUE_TEMPLATE/20-documentation-issue.yml | 22 ++++++++++ .github/ISSUE_TEMPLATE/30-feature-request.md | 31 ------------- .github/ISSUE_TEMPLATE/30-feature-request.yml | 24 +++++++++++ 8 files changed, 128 insertions(+), 127 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/00-bug-issue.md create mode 100644 .github/ISSUE_TEMPLATE/00-bug-issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/10-installation-issue.md create mode 100644 .github/ISSUE_TEMPLATE/10-installation-issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/20-documentation-issue.md create mode 100644 .github/ISSUE_TEMPLATE/20-documentation-issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/30-feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/30-feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/00-bug-issue.md b/.github/ISSUE_TEMPLATE/00-bug-issue.md deleted file mode 100644 index aafaa083d..000000000 --- a/.github/ISSUE_TEMPLATE/00-bug-issue.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: 🐛 Bug Report -about: Use this template for reporting a bug ---- - - - -**Describe the current behavior** - -**Steps to reproduce:** - -1. -2. -3. - -**Describe the expected behavior** - -**Additional information** - -* PeerTube instance: - * URL: - * version: - * NodeJS version: - * Ffmpeg version: - -* Browser name, version and platforms on which you could reproduce the bug: -* Link to browser console log if relevant: -* Link to server log if relevant (`journalctl` or `/var/www/peertube/storage/logs/`): diff --git a/.github/ISSUE_TEMPLATE/00-bug-issue.yml b/.github/ISSUE_TEMPLATE/00-bug-issue.yml new file mode 100644 index 000000000..6bcf1cba4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-bug-issue.yml @@ -0,0 +1,43 @@ +name: 🐛 Bug Report +description: Use this template for reporting a bug +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: | + Please search among past open/closed issues for a similar one beforehand: + - https://github.com/Chocobozzz/PeerTube/issues?q= + - https://framacolibri.org/c/peertube + options: + - label: I have searched existing issues + required: true + + - type: textarea + attributes: + label: Describe the current behavior + + - type: textarea + attributes: + label: Steps to reproduce + value: | + 1. + 2. + 3. + + - type: textarea + attributes: + label: Describe the expected behavior + + - type: textarea + attributes: + label: Additional information + value: | + * PeerTube instance: + * URL: + * Version: + * NodeJS version: + * Ffmpeg version: + + * Browser name, version and platforms on which you could reproduce the bug: + * Link to browser console log if relevant: + * Link to server log if relevant (`journalctl` or `/var/www/peertube/storage/logs/`): diff --git a/.github/ISSUE_TEMPLATE/10-installation-issue.md b/.github/ISSUE_TEMPLATE/10-installation-issue.md deleted file mode 100644 index 4af9a1192..000000000 --- a/.github/ISSUE_TEMPLATE/10-installation-issue.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: 🚀 Installation Issue -about: Use this template for build/installation issues ---- - - - -**Describe the problem** - -**Provide the exact sequence of commands / steps that you executed before running into the problem** - -**Additional information** - -* PeerTube instance: - * version: - * NodeJS version: - * Ffmpeg version: - * Redis version: - * PostgreSQL version: - - diff --git a/.github/ISSUE_TEMPLATE/10-installation-issue.yml b/.github/ISSUE_TEMPLATE/10-installation-issue.yml new file mode 100644 index 000000000..9bdf35dfb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10-installation-issue.yml @@ -0,0 +1,39 @@ +name: 🚀 Installation/Upgrade Issue +description: Use this template for build/installation/upgrade issues +body: + - type: checkboxes + attributes: + label: Have you read the documentation? + description: | + Please check the official documentation first + - Classic installation: https://docs.joinpeertube.org/install-any-os + - Docker installation: https://docs.joinpeertube.org/install-docker + options: + - label: I have read the documentation + required: true + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: | + Please search among past open/closed issues for a similar one beforehand: + - https://github.com/Chocobozzz/PeerTube/issues?q= + - https://framacolibri.org/c/peertube + options: + - label: I have searched existing issues + required: true + + - type: textarea + attributes: + label: Describe the problem + + - type: textarea + attributes: + label: Additional information + value: | + * PeerTube instance URL: + * PeerTube version: + * NodeJS version: + * Ffmpeg version: + * Redis version: + * PostgreSQL version: diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.md b/.github/ISSUE_TEMPLATE/20-documentation-issue.md deleted file mode 100644 index 27bfc9cff..000000000 --- a/.github/ISSUE_TEMPLATE/20-documentation-issue.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: 📝 Documentation Issue -about: Use this template for documentation-related issues -labels: 'Component: Documentation :books:' -assignees: rigelk ---- - - - -**Parts of the documentation concerned:** - - - -**Describe the desired information/correction** - - diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.yml b/.github/ISSUE_TEMPLATE/20-documentation-issue.yml new file mode 100644 index 000000000..213aeb401 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/20-documentation-issue.yml @@ -0,0 +1,22 @@ +name: 📝 Documentation Issue +description: Use this template for documentation-related issues +labels: [ 'Component: Documentation :books:' ] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: | + Please search among past open/closed issues for a similar one beforehand: + - https://github.com/Chocobozzz/PeerTube/issues?q= + - https://framacolibri.org/c/peertube + options: + - label: I have searched existing issues + required: true + + - type: textarea + attributes: + label: Describe the desired information/correction + description: | + Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try: + * Click "Edit this page" if on https://docs.joinpeertube.org + * Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api-rest-reference.html diff --git a/.github/ISSUE_TEMPLATE/30-feature-request.md b/.github/ISSUE_TEMPLATE/30-feature-request.md deleted file mode 100644 index bb2cf20aa..000000000 --- a/.github/ISSUE_TEMPLATE/30-feature-request.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: ✨ Feature Request -about: Use this template to ask for new features and suggest new ideas 💡 ---- - - - -**Describe the problem to be solved** - - - -**Describe the solution you would like:** - - - -**Describe alternatives you have considered** - - diff --git a/.github/ISSUE_TEMPLATE/30-feature-request.yml b/.github/ISSUE_TEMPLATE/30-feature-request.yml new file mode 100644 index 000000000..e4337348c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/30-feature-request.yml @@ -0,0 +1,24 @@ +--- +name: ✨ Feature Request +description: Use this template to ask for new features and suggest new ideas 💡 +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: | + Please search among past open/closed issues for a similar one beforehand: + - https://github.com/Chocobozzz/PeerTube/issues?q= + - https://framacolibri.org/c/peertube + options: + - label: I have searched existing issues + required: true + + - type: textarea + attributes: + label: Describe the problem to be solved + description: Provide a clear and concise description of what the problem is + + - type: textarea + attributes: + label: Describe the solution you would like + description: Provide a clear and concise description of what you want to happen