From d0c1c1cbc1e6b560d99bcb5369dba83ca4b8d1b9 Mon Sep 17 00:00:00 2001 From: Corentin THOMASSET Date: Mon, 2 Sep 2024 22:34:59 +0200 Subject: [PATCH] chore(repo): added issue templates (#78) --- .github/ISSUE_TEMPLATE/bug-report.yml | 49 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature-request.yml | 51 ++++++++++++++++++++++ 3 files changed, 101 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..24d786b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,49 @@ +name: 🐞 Bug Report +description: File a bug report. +labels: ['bug', 'triage'] +assignees: + - CorentinTh +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? If you have a screenshot, you can paste it here. + placeholder: Tell us what you see! + value: 'A bug happened!' + validations: + required: true + + - type: textarea + id: version + attributes: + label: System information + description: What is you environment? You can use the `npx envinfo --system --browsers` command to get this information. + validations: + required: true + + - type: dropdown + id: app-type + attributes: + label: Where did you encounter the bug? + options: + - Public app (enclosed.cc) + - Documentation website (docs.enclosed.cc) + - A self hosted instance + - Other (installations, docker, etc.) + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..a49eab2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..7acb4756 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,51 @@ +name: 🚀 New feature proposal +description: Propose a new feature/enhancement +labels: ['enhancement', 'triage'] + +body: + - type: markdown + attributes: + value: | + Thanks for your interest in the project and taking the time to fill out this feature report! + + - type: dropdown + id: request-type + attributes: + label: What type of request is this? + options: + - New feature idea + - Enhancement of an existing feature + - Deployment or CI/CD improvement + - Hosting or Self-hosting improvement + - Related to documentation + - Other + validations: + required: true + + - type: textarea + id: feature-description + attributes: + label: Clear and concise description of the feature you are proposing + description: A clear and concise description of what the feature is. + placeholder: 'Example: I would like to see...' + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context or screenshots about the feature request here. + + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Check the feature is not already implemented in the project. + required: true + - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. + required: true + - label: Check that the feature is technically feasible and aligns with the project's goals. + required: true