From 310eff393d381b7ea8541321a7da8c2c23089355 Mon Sep 17 00:00:00 2001 From: krille-chan Date: Wed, 19 Jul 2023 05:55:46 +0200 Subject: [PATCH] docs: Better issue templates and adding config.yml --- .github/ISSUE_TEMPLATE/bug_report.md | 106 ++++++++++++++++------ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.md | 93 ++++++++++++++----- 3 files changed, 152 insertions(+), 55 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4b95eb41..017ad173 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,30 +1,76 @@ ---- -name: Bug report -about: Create a report to help us improve -labels: Bug ---- - -### Describe the bug - - -### To Reproduce - - - - - - -### Expected behavior - - -### Screenshots - - -### Platform (please complete the following information): - - - - - -### Additional context - +name: 🐛 Bug report +description: Create a report to help us improve +labels: ["Bug"] +body: + - type: markdown + attributes: + value: "## Describe the bug" + - type: textarea + id: bug-description + attributes: + label: "Bug Description" + description: "A clear and concise description of what the bug is." + placeholder: "Describe the bug here..." + validations: + required: true + - type: markdown + attributes: + value: "## To Reproduce" + - type: textarea + id: reproduce-steps + attributes: + label: "Steps to Reproduce" + description: "Steps to reproduce the behavior:" + placeholder: "1. Go to '...'\n2. Click on '...'\n3. Scroll down to '...'\n4. See error" + validations: + required: true + - type: markdown + attributes: + value: "## Expected behavior" + - type: textarea + id: expected-behavior + attributes: + label: "Expected Behavior" + description: "A clear and concise description of what you expected to happen." + placeholder: "Describe what you expected to happen here..." + validations: + required: true + - type: markdown + attributes: + value: "## Screenshots" + - type: input + id: screenshots + attributes: + label: "Screenshots" + description: "If applicable, add screenshots to help explain your problem." + validations: + required: false + - type: markdown + attributes: + value: "## Platform" + - type: input + id: app-version + attributes: + label: "App Version" + description: "Please provide the version of the app you are using." + placeholder: "e.g. 1.12.0" + validations: + required: true + - type: input + id: platform-info + attributes: + label: "Additional Platform Information" + description: "Please provide the following information:" + placeholder: "Device: [e.g. iPhone6, PC, Pixel 3]\nOS: [e.g. iOS, Android, Windows, Linux, macOS]\nBrowser (if applicable): [e.g. Chrome, Safari]" + validations: + required: true + - type: markdown + attributes: + value: "## Additional context" + - type: textarea + id: additional-context + attributes: + label: "Additional Context" + description: "Add any other context about the problem here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..c91153ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: FluffyChat Community + url: https://matrix.to/#/#fluffychat:matrix.org + about: Please ask and answer questions here. + - name: Report security vulnerabilities + url: https://matrix.to/#/@krille:janian.de + about: Please report security vulnerabilities here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 3c7271d2..2daee697 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,25 +1,68 @@ ---- -name: Feature Request -about: Suggest an idea for this project -labels: Enhancement ---- - -### Feature Description - - -### Rationale - - -### Functionality - - -### Mockup - - -### Platform (please complete the following information if applicable): - - - - -### Additional context - +name: 💡 Feature Request +description: Suggest an idea for this project +labels: ["Enhancement"] +body: + - type: markdown + attributes: + value: "## Feature Description" + - type: textarea + id: feature-description + attributes: + label: "Feature Description" + description: "Provide a clear and concise description of the feature." + placeholder: "Describe the feature here..." + validations: + required: true + - type: markdown + attributes: + value: "## Rationale" + - type: textarea + id: rationale + attributes: + label: "Rationale" + description: "Explain why this feature should be added." + placeholder: "Describe the rationale for the feature here..." + validations: + required: true + - type: markdown + attributes: + value: "## Functionality" + - type: textarea + id: functionality + attributes: + label: "Functionality" + description: "Describe what the feature would do and how it should work." + placeholder: "Describe the functionality of the feature here..." + validations: + required: true + - type: markdown + attributes: + value: "## Mockup" + - type: input + id: mockup + attributes: + label: "Mockup" + description: "If applicable, add any visual mock-ups of the feature." + validations: + required: false + - type: markdown + attributes: + value: "## Platform" + - type: input + id: platform-info + attributes: + label: "Platform Information" + description: "Please provide the following information if applicable:" + placeholder: "OS: [e.g. iOS, Android, Windows, Linux, macOS]\nBrowser [e.g. Chrome, Safari]\nVersion [e.g. 22]" + validations: + required: false + - type: markdown + attributes: + value: "## Additional context" + - type: textarea + id: additional-context + attributes: + label: "Additional Context" + description: "Add any other context or screenshots about the feature request here." + validations: + required: false