From c0b982d9a94f8d6283ca647112db34c49e64869d Mon Sep 17 00:00:00 2001 From: cogwheel0 <172976095+cogwheel0@users.noreply.github.com> Date: Wed, 27 Aug 2025 22:09:01 +0530 Subject: [PATCH] docs: add ISSUE_TEMPLATE --- .github/ISSUE_TEMPLATE/bug_report.yml | 107 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature_request.yml | 56 +++++++++++ 3 files changed, 168 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..9ed2884 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,107 @@ +name: 🐛 Bug Report +description: Create a report to help improve Conduit. +title: '[BUG] ' +labels: ['bug', 'triage'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! This helps make Conduit better. + + **Note:** Bugs are tricky to understand. The more details you can provide, the faster I can fix it. + + - type: input + id: app-version + attributes: + label: App Version + description: "Tap/Click on Manage → About App" + placeholder: "1.1.1+5" + validations: + required: true + + - type: checkboxes + id: platform + attributes: + label: Platform + description: "On which platform did you encounter the bug?" + options: + - label: Android + - label: iOS + validations: + required: true + + - type: dropdown + id: installation-method + attributes: + label: How you installed it + description: "How did you install Conduit?" + options: + - App Store + - Google Play + - GitHub Releases + - Built from source + - Other + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: "A clear description of what went wrong" + placeholder: "Describe the bug you encountered..." + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: What should have happened? + description: "What you expected to see instead" + placeholder: "Describe what you expected to happen..." + validations: + required: true + + - type: textarea + id: reproduction-steps + attributes: + label: How to reproduce + description: "Step-by-step instructions to reproduce the bug" + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. See the problem + validations: + required: true + + - type: dropdown + id: frequency + attributes: + label: Does this happen every time? + description: "How often does this bug occur?" + options: + - Yes, every time + - No, only sometimes + - Rarely + - Not sure + + - type: textarea + id: when-started + attributes: + label: When did this start? + description: "When did you first notice this issue?" + placeholder: "e.g., After updating, Always, Sometimes, After a specific action..." + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: "If you can, add a screenshot to help explain the problem" + placeholder: "Drag and drop screenshots here or paste image URLs..." + + - type: textarea + id: logs + attributes: + label: Logs + description: "Please include any error messages you see in the app." + placeholder: "Paste any logs or error output here..." diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0a236eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Discussions + url: https://github.com/cogwheel0/conduit/discussions + about: For general questions and discussions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..68f413e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,56 @@ +name: 💡 Feature Request +description: Suggest an idea for Conduit. +title: '[FEAT] ' +labels: ['enhancement', 'triage'] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! This helps make Conduit better. + + Please provide as much detail as possible so I can understand what you're looking for. + + - type: textarea + id: feature-description + attributes: + label: What would you like? + description: "A clear description of what you'd like to see added" + placeholder: "Describe the feature you want..." + validations: + required: true + + - type: textarea + id: why-needed + attributes: + label: Why do you want this? + description: "What problem would this solve, or what would it make better?" + placeholder: "Explain why this feature would be useful..." + validations: + required: true + + - type: checkboxes + id: platforms + attributes: + label: Which platforms? + description: "Where should this feature work?" + options: + - label: "Android" + - label: "iOS" + + - type: textarea + id: examples + attributes: + label: Examples + description: "If you can, add a sketch, screenshot, or link to a similar feature in another app" + placeholder: "Add examples, sketches, or links to similar features..." + + - type: dropdown + id: importance + attributes: + label: How important is this to you? + description: "How much would this feature improve your experience?" + options: + - Nice to have + - Would be useful + - Really need this + - Can't work without it