From 3c8903ac662dc306d8497e1f9d760b8e4f873926 Mon Sep 17 00:00:00 2001 From: default Date: Tue, 17 Feb 2026 21:09:34 +0000 Subject: [PATCH] DOCS: Updated the Issue templates to YAMLs for form like issue entry --- .gitea/issue_template/bug_report.md | 46 ------- .gitea/issue_template/bug_report.yml | 112 ++++++++++++++++++ .gitea/issue_template/documentation.md | 45 ------- .gitea/issue_template/documentation.yml | 68 +++++++++++ .gitea/issue_template/feature_request.md | 54 --------- .gitea/issue_template/feature_request.yml | 90 ++++++++++++++ .../issue_template/security_vulnerability.md | 44 ------- .../issue_template/security_vulnerability.yml | 56 +++++++++ .gitea/issue_template/support_request.md | 52 -------- .gitea/issue_template/support_request.yml | 95 +++++++++++++++ 10 files changed, 421 insertions(+), 241 deletions(-) delete mode 100644 .gitea/issue_template/bug_report.md create mode 100644 .gitea/issue_template/bug_report.yml delete mode 100644 .gitea/issue_template/documentation.md create mode 100644 .gitea/issue_template/documentation.yml delete mode 100644 .gitea/issue_template/feature_request.md create mode 100644 .gitea/issue_template/feature_request.yml delete mode 100644 .gitea/issue_template/security_vulnerability.md create mode 100644 .gitea/issue_template/security_vulnerability.yml delete mode 100644 .gitea/issue_template/support_request.md create mode 100644 .gitea/issue_template/support_request.yml diff --git a/.gitea/issue_template/bug_report.md b/.gitea/issue_template/bug_report.md deleted file mode 100644 index bc5a089..0000000 --- a/.gitea/issue_template/bug_report.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: ๐Ÿ› Bug Report -about: Report a bug or unexpected behavior -title: '[BUG] ' -labels: bug, status:investigating -assignees: '' ---- - -## Bug Description - - -## Steps to Reproduce -1. -2. -3. - -## Expected Behavior - - -## Actual Behavior - - -## Environment -- **Subscription Tier**: Sandbox / Indie / Studio / Enterprise -- **Endpoint Used**: (e.g., POST /api/v1/webhooks/stripe/...) -- **Timestamp**: (e.g., 2026-02-13T10:30:00Z) -- **Event ID** (if applicable): evt_... -- **Browser** (if dashboard issue): Chrome / Firefox / Safari / Edge - -## Screenshots / Logs - -``` -Paste logs here -``` - -## Additional Context - - -## Workaround - - ---- - -**โš ๏ธ SECURITY WARNING** -Do NOT include API keys, secrets, or sensitive customer data. -For security issues, email security@evercatch.dev instead. diff --git a/.gitea/issue_template/bug_report.yml b/.gitea/issue_template/bug_report.yml new file mode 100644 index 0000000..a10bfd0 --- /dev/null +++ b/.gitea/issue_template/bug_report.yml @@ -0,0 +1,112 @@ +name: ๐Ÿ› Bug Report +about: Report a bug or unexpected behavior +title: '[BUG] ' +labels: ['bug', 'status:investigating'] +body: + - type: markdown + attributes: + value: | + > **โš ๏ธ SECURITY WARNING:** Do NOT include API keys, secrets, or sensitive customer data. + > For security issues, email **security@evercatch.dev** instead. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear description of what the bug is. + placeholder: Describe the bug... + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Step-by-step instructions to reproduce the behavior. + placeholder: | + 1. + 2. + 3. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What you expected to happen. + placeholder: I expected... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened. + placeholder: Instead, what happened was... + validations: + required: true + + - type: dropdown + id: tier + attributes: + label: Subscription Tier + options: + - Sandbox (Free) + - Indie + - Studio + - Enterprise + validations: + required: true + + - type: input + id: endpoint + attributes: + label: Endpoint Used + description: The API endpoint related to this bug. + placeholder: 'e.g. POST /api/v1/webhooks/stripe/...' + + - type: input + id: timestamp + attributes: + label: Timestamp + description: When did this occur? + placeholder: 'e.g. 2026-02-13T10:30:00Z' + + - type: input + id: event-id + attributes: + label: Event ID (if applicable) + placeholder: 'e.g. evt_...' + + - type: dropdown + id: browser + attributes: + label: Browser (if dashboard issue) + options: + - N/A + - Chrome + - Firefox + - Safari + - Edge + - Other + + - type: textarea + id: logs + attributes: + label: Screenshots / Logs + description: If applicable, paste error logs or describe screenshots. + render: shell + + - type: textarea + id: workaround + attributes: + label: Workaround + description: If you found a temporary workaround, share it here. + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context about the problem. diff --git a/.gitea/issue_template/documentation.md b/.gitea/issue_template/documentation.md deleted file mode 100644 index 0017c80..0000000 --- a/.gitea/issue_template/documentation.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: ๐Ÿ“š Documentation Issue -about: Report missing, incorrect, or unclear documentation -title: '[DOCS] ' -labels: documentation -assignees: '' ---- - -## Documentation Page - -https://docs.evercatch.dev/... - -## Issue Type -- [ ] Missing documentation -- [ ] Incorrect information -- [ ] Unclear/confusing explanation -- [ ] Broken link -- [ ] Code example doesn't work -- [ ] Typo/grammar -- [ ] Outdated information - -## Description - - -## Current Content - -``` -Current text/code here -``` - -## Suggested Fix - -``` -Suggested text/code here -``` - -## Additional Context - - -## Impact - -- [ ] Critical - Causes errors if followed -- [ ] High - Likely to confuse users -- [ ] Medium - Could be clearer -- [ ] Low - Minor improvement diff --git a/.gitea/issue_template/documentation.yml b/.gitea/issue_template/documentation.yml new file mode 100644 index 0000000..7cdbb0a --- /dev/null +++ b/.gitea/issue_template/documentation.yml @@ -0,0 +1,68 @@ +name: ๐Ÿ“š Documentation Issue +about: Report missing, incorrect, or unclear documentation +title: '[DOCS] ' +labels: ['documentation'] +body: + - type: input + id: page-url + attributes: + label: Documentation Page + description: Link to the docs page with the issue. + placeholder: 'https://docs.evercatch.dev/...' + validations: + required: true + + - type: checkboxes + id: issue-type + attributes: + label: Issue Type + options: + - label: Missing documentation + - label: Incorrect information + - label: Unclear/confusing explanation + - label: Broken link + - label: Code example doesn't work + - label: Typo/grammar + - label: Outdated information + + - type: textarea + id: description + attributes: + label: Description + description: What's wrong with the docs? + placeholder: The problem is... + validations: + required: true + + - type: textarea + id: current + attributes: + label: Current Content + description: Quote the current problematic content. + render: markdown + + - type: textarea + id: suggested + attributes: + label: Suggested Fix + description: How would you improve it? + render: markdown + + - type: textarea + id: context + attributes: + label: Additional Context + description: Screenshots, correct information, working examples, etc. + + - type: dropdown + id: impact + attributes: + label: Impact + description: How does this affect users? + options: + - Critical - Causes errors if followed + - High - Likely to confuse users + - Medium - Could be clearer + - Low - Minor improvement + validations: + required: true diff --git a/.gitea/issue_template/feature_request.md b/.gitea/issue_template/feature_request.md deleted file mode 100644 index 4ecc696..0000000 --- a/.gitea/issue_template/feature_request.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: โœจ Feature Request -about: Suggest a new feature or enhancement -title: '[FEATURE] ' -labels: feature -assignees: '' ---- - -## Problem Statement - - -## Proposed Solution - - -## Use Case - - -**Example scenario:** -``` -When I... [describe situation] -I want to... [describe action] -So that... [describe benefit] -``` - -## Current Workaround - - -## Tier Relevance - -- [ ] Sandbox (Free) -- [ ] Indie -- [ ] Studio -- [ ] Enterprise -- [ ] All tiers - -## Similar Features - - -## Additional Context - - -## Impact - -- [ ] Critical - Blocking my business -- [ ] High - Very useful -- [ ] Medium - Nice to have -- [ ] Low - Just an idea - -## Willingness to Pay - -- [ ] Yes, I would upgrade immediately -- [ ] Yes, I would consider upgrading -- [ ] No, but it would improve my experience -- [ ] N/A - Already on Enterprise diff --git a/.gitea/issue_template/feature_request.yml b/.gitea/issue_template/feature_request.yml new file mode 100644 index 0000000..656e7c9 --- /dev/null +++ b/.gitea/issue_template/feature_request.yml @@ -0,0 +1,90 @@ +name: โœจ Feature Request +about: Suggest a new feature or enhancement +title: '[FEATURE] ' +labels: ['feature'] +body: + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem does this feature solve? + placeholder: I'm frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe your ideal solution. + placeholder: I would like... + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: How would you use this feature? Be specific. + placeholder: | + When I... [describe situation] + I want to... [describe action] + So that... [describe benefit] + validations: + required: true + + - type: textarea + id: workaround + attributes: + label: Current Workaround + description: How are you currently handling this? + + - type: checkboxes + id: tier + attributes: + label: Tier Relevance + description: Which subscription tier(s) would benefit most? + options: + - label: Sandbox (Free) + - label: Indie + - label: Studio + - label: Enterprise + - label: All tiers + + - type: textarea + id: similar + attributes: + label: Similar Features + description: Have you seen this feature in other products? + + - type: textarea + id: context + attributes: + label: Additional Context + description: Screenshots, mockups, examples from competitors, etc. + + - type: dropdown + id: impact + attributes: + label: Impact + description: How important is this feature to you? + options: + - Critical - Blocking my business + - High - Very useful + - Medium - Nice to have + - Low - Just an idea + validations: + required: true + + - type: dropdown + id: willingness + attributes: + label: Willingness to Pay + description: Would you upgrade your tier for this feature? + options: + - 'Yes, I would upgrade immediately' + - 'Yes, I would consider upgrading' + - No, but it would improve my experience + - N/A - Already on Enterprise + validations: + required: true diff --git a/.gitea/issue_template/security_vulnerability.md b/.gitea/issue_template/security_vulnerability.md deleted file mode 100644 index 7e9c6e3..0000000 --- a/.gitea/issue_template/security_vulnerability.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: ๐Ÿ” Security Vulnerability -about: Report a security issue (PRIVATE - use email instead) -title: 'DO NOT USE - Email security@evercatch.dev' -labels: security -assignees: '' ---- - -# โš ๏ธ STOP - DO NOT USE THIS TEMPLATE - -**Security vulnerabilities should NOT be reported publicly.** - -Please email us instead: **security@evercatch.dev** - -## Why? - -Public disclosure of security issues can: -- Put user data at risk -- Allow attackers to exploit the vulnerability -- Violate responsible disclosure practices - -## What to Include in Your Email - -- **Description** - What is the vulnerability? -- **Steps to Reproduce** - How can we reproduce it? -- **Impact** - What could an attacker do? -- **Proof of Concept** - Code or screenshots (optional) -- **Suggested Fix** - If you have one -- **Your Contact Info** - For follow-up - -## Our Commitment - -- โœ… Response within 24 hours -- โœ… Updates every 48 hours -- โœ… Credit in security advisories (if desired) -- โœ… Potential bug bounty (for critical issues) - -## Security Policy - -Read our full security policy: [SECURITY.md](../../SECURITY.md) - ---- - -**Thank you for keeping Evercatch secure!** ๐Ÿ”’ diff --git a/.gitea/issue_template/security_vulnerability.yml b/.gitea/issue_template/security_vulnerability.yml new file mode 100644 index 0000000..f9acb56 --- /dev/null +++ b/.gitea/issue_template/security_vulnerability.yml @@ -0,0 +1,56 @@ +name: ๐Ÿ” Security Vulnerability +about: Report a security issue (PRIVATE - use email instead) +title: 'DO NOT USE - Email security@evercatch.dev' +labels: ['security'] +body: + - type: markdown + attributes: + value: | + # โš ๏ธ STOP โ€” DO NOT USE THIS TEMPLATE + + **Security vulnerabilities should NOT be reported publicly.** + + Please email us instead: **security@evercatch.dev** + + --- + + ### Why? + + Public disclosure of security issues can: + - Put user data at risk + - Allow attackers to exploit the vulnerability before a fix is ready + - Violate responsible disclosure practices + + --- + + ### What to Include in Your Email + + - **Description** โ€” What is the vulnerability? + - **Steps to Reproduce** โ€” How can we reproduce it? + - **Impact** โ€” What could an attacker do? + - **Proof of Concept** โ€” Code or screenshots (optional) + - **Suggested Fix** โ€” If you have one + - **Your Contact Info** โ€” For follow-up + + --- + + ### Our Commitment + + - โœ… Response within 24 hours + - โœ… Updates every 48 hours + - โœ… Credit in security advisories (if desired) + - โœ… Potential bug bounty for critical issues + + Read our full security policy: [SECURITY.md](../../SECURITY.md) + + --- + + **Thank you for keeping Evercatch secure! ๐Ÿ”’** + + - type: checkboxes + id: acknowledge + attributes: + label: Acknowledgement + options: + - label: I understand I should email security@evercatch.dev instead of using this form. + required: true diff --git a/.gitea/issue_template/support_request.md b/.gitea/issue_template/support_request.md deleted file mode 100644 index feac25d..0000000 --- a/.gitea/issue_template/support_request.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: โ“ Support Request -about: Get help with using Evercatch -title: '[SUPPORT] ' -labels: question -assignees: '' ---- - -## Issue Summary - - -## What I'm Trying to Do - - -## What I've Tried - - -1. -2. -3. - -## Account Information -- **Email**: (your account email) -- **User ID** (if known): -- **Subscription Tier**: Sandbox / Indie / Studio / Enterprise - -## Relevant Documentation - -- [ ] I've searched [docs.evercatch.dev](https://docs.evercatch.dev) -- [ ] I've checked [existing issues](../../issues) -- [ ] I've reviewed the [API docs](https://docs.evercatch.dev/api) - -## Error Messages - -``` -Paste error here -``` - -## Questions -1. -2. - -## Screenshots - - ---- - -**๐Ÿ’ก TIP:** Before opening a support ticket, check: -- [Documentation](https://docs.evercatch.dev) -- [API Reference](https://docs.evercatch.dev/api) -- [Existing Issues](../../issues) -- [Status Page](https://status.evercatch.dev) diff --git a/.gitea/issue_template/support_request.yml b/.gitea/issue_template/support_request.yml new file mode 100644 index 0000000..aae8055 --- /dev/null +++ b/.gitea/issue_template/support_request.yml @@ -0,0 +1,95 @@ +name: โ“ Support Request +about: Get help with using Evercatch +title: '[SUPPORT] ' +labels: ['question'] +body: + - type: markdown + attributes: + value: | + **๐Ÿ’ก Before opening a ticket, please check:** + [Documentation](https://docs.evercatch.dev) ยท [API Reference](https://docs.evercatch.dev/api) ยท [Existing Issues](../../issues) ยท [Status Page](https://status.evercatch.dev) + + - type: textarea + id: summary + attributes: + label: Issue Summary + description: Brief description of what you need help with. + placeholder: I need help with... + validations: + required: true + + - type: textarea + id: goal + attributes: + label: What I'm Trying to Do + description: Describe your goal. + placeholder: My goal is to... + validations: + required: true + + - type: textarea + id: tried + attributes: + label: What I've Tried + description: List what you've already attempted. + placeholder: | + 1. + 2. + 3. + validations: + required: true + + - type: input + id: email + attributes: + label: Account Email + placeholder: you@example.com + + - type: input + id: user-id + attributes: + label: User ID (if known) + placeholder: usr_... + + - type: dropdown + id: tier + attributes: + label: Subscription Tier + options: + - Sandbox (Free) + - Indie + - Studio + - Enterprise + validations: + required: true + + - type: checkboxes + id: docs-checked + attributes: + label: Relevant Documentation + description: Please confirm you've checked these resources. + options: + - label: I've searched [docs.evercatch.dev](https://docs.evercatch.dev) + - label: I've checked [existing issues](../../issues) + - label: I've reviewed the [API docs](https://docs.evercatch.dev/api) + + - type: textarea + id: errors + attributes: + label: Error Messages + description: If applicable, paste any error messages. + render: shell + + - type: textarea + id: questions + attributes: + label: Questions + placeholder: | + 1. + 2. + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, describe or attach screenshots.