From 1e812875d7dc2d1d60c925e61729642e993b96bb Mon Sep 17 00:00:00 2001 From: Chen Asraf Date: Tue, 11 Nov 2025 02:17:07 +0200 Subject: [PATCH] docs: add issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 118 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 71 +++++++++++++ 3 files changed, 197 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 0000000..feeb8db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,118 @@ +name: Bug Report +description: Report a bug or issue with the Forum app +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the information below to help us investigate. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: Describe the bug... + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What you expected to happen + placeholder: Describe what should happen... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened + placeholder: Describe what actually happens... + validations: + required: true + + - type: input + id: nextcloud-version + attributes: + label: Nextcloud Version + description: What version of Nextcloud are you running? + placeholder: e.g., 28.0.1 + validations: + required: true + + - type: input + id: app-version + attributes: + label: Forum App Version + description: What version of the Forum app are you using? + placeholder: e.g., 1.0.0 + validations: + required: true + + - type: input + id: php-version + attributes: + label: PHP Version + description: What version of PHP is your server running? + placeholder: e.g., 8.2.12 + validations: + required: true + + - type: dropdown + id: database + attributes: + label: Database + description: Which database are you using? + options: + - SQLite + - MySQL/MariaDB + - PostgreSQL + - Other + validations: + required: true + + - type: input + id: browser + attributes: + label: Browser + description: Which browser are you using? (if applicable) + placeholder: e.g., Firefox 120, Chrome 119, Safari 17 + + - type: textarea + id: logs + attributes: + label: Relevant Logs + description: | + Please paste any relevant logs from: + - Nextcloud log (Settings → Logging) + - Browser console (F12 → Console tab) + - PHP error logs + render: shell + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0bb0870 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Nextcloud Community Forum + url: https://help.nextcloud.com + about: Ask questions and get help from the Nextcloud community + - name: Security Issue + url: https://github.com/chenasraf/nextcloud-forum/security/advisories/new + about: Report a security vulnerability privately diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..060637c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,71 @@ +name: Feature Request +description: Suggest a new feature or enhancement for the Forum app +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature! Please provide as much detail as possible to help us understand your request. + + - type: textarea + id: summary + attributes: + label: Feature Summary + description: A brief summary of the feature you'd like to see + placeholder: Summarize the feature in 1-2 sentences... + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem or Use Case + description: | + What problem does this feature solve? What's your use case? + Tip: "I'm always frustrated when..." + placeholder: Describe the problem or use case... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: How would you like this feature to work? + placeholder: Describe your proposed solution... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or workarounds? + placeholder: Describe any alternative solutions or features you've considered... + + - type: textarea + id: examples + attributes: + label: Examples + description: | + Are there any similar features in other apps/forums that demonstrate what you're looking for? + placeholder: Provide links or descriptions of similar features elsewhere... + + - type: dropdown + id: willing-to-contribute + attributes: + label: Willing to Contribute? + description: Would you be willing to contribute code for this feature? + options: + - "Yes, I can submit a PR" + - "Maybe, with guidance" + - "No, but I can help test" + - "No" + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context, mockups, or screenshots about the feature request here