DOCS: Updated the Issue templates to YAMLs for form like issue entry
This commit is contained in:
@@ -1,46 +0,0 @@
|
||||
---
|
||||
name: 🐛 Bug Report
|
||||
about: Report a bug or unexpected behavior
|
||||
title: '[BUG] '
|
||||
labels: bug, status:investigating
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Bug Description
|
||||
<!-- A clear description of what the bug is -->
|
||||
|
||||
## Steps to Reproduce
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Expected Behavior
|
||||
<!-- What you expected to happen -->
|
||||
|
||||
## Actual Behavior
|
||||
<!-- What actually happened -->
|
||||
|
||||
## 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
|
||||
<!-- If applicable, add screenshots or error logs -->
|
||||
```
|
||||
Paste logs here
|
||||
```
|
||||
|
||||
## Additional Context
|
||||
<!-- Any other context about the problem -->
|
||||
|
||||
## Workaround
|
||||
<!-- If you found a temporary workaround, share it here -->
|
||||
|
||||
---
|
||||
|
||||
**⚠️ SECURITY WARNING**
|
||||
Do NOT include API keys, secrets, or sensitive customer data.
|
||||
For security issues, email security@evercatch.dev instead.
|
||||
112
.gitea/issue_template/bug_report.yml
Normal file
112
.gitea/issue_template/bug_report.yml
Normal file
@@ -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.
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
name: 📚 Documentation Issue
|
||||
about: Report missing, incorrect, or unclear documentation
|
||||
title: '[DOCS] '
|
||||
labels: documentation
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Documentation Page
|
||||
<!-- Link to the docs page with the issue -->
|
||||
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
|
||||
<!-- What's wrong with the docs? -->
|
||||
|
||||
## Current Content
|
||||
<!-- Quote the current problematic content -->
|
||||
```
|
||||
Current text/code here
|
||||
```
|
||||
|
||||
## Suggested Fix
|
||||
<!-- How would you improve it? -->
|
||||
```
|
||||
Suggested text/code here
|
||||
```
|
||||
|
||||
## Additional Context
|
||||
<!-- Screenshots, correct information, working examples, etc. -->
|
||||
|
||||
## Impact
|
||||
<!-- How does this affect users? -->
|
||||
- [ ] Critical - Causes errors if followed
|
||||
- [ ] High - Likely to confuse users
|
||||
- [ ] Medium - Could be clearer
|
||||
- [ ] Low - Minor improvement
|
||||
68
.gitea/issue_template/documentation.yml
Normal file
68
.gitea/issue_template/documentation.yml
Normal file
@@ -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
|
||||
@@ -1,54 +0,0 @@
|
||||
---
|
||||
name: ✨ Feature Request
|
||||
about: Suggest a new feature or enhancement
|
||||
title: '[FEATURE] '
|
||||
labels: feature
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Problem Statement
|
||||
<!-- What problem does this feature solve? -->
|
||||
|
||||
## Proposed Solution
|
||||
<!-- Describe your ideal solution -->
|
||||
|
||||
## Use Case
|
||||
<!-- How would you use this feature? Be specific. -->
|
||||
|
||||
**Example scenario:**
|
||||
```
|
||||
When I... [describe situation]
|
||||
I want to... [describe action]
|
||||
So that... [describe benefit]
|
||||
```
|
||||
|
||||
## Current Workaround
|
||||
<!-- How are you currently handling this? -->
|
||||
|
||||
## Tier Relevance
|
||||
<!-- Which subscription tier would benefit most? -->
|
||||
- [ ] Sandbox (Free)
|
||||
- [ ] Indie
|
||||
- [ ] Studio
|
||||
- [ ] Enterprise
|
||||
- [ ] All tiers
|
||||
|
||||
## Similar Features
|
||||
<!-- Have you seen this feature in other products? -->
|
||||
|
||||
## Additional Context
|
||||
<!-- Screenshots, mockups, examples from competitors, etc. -->
|
||||
|
||||
## Impact
|
||||
<!-- How important is this feature to you? -->
|
||||
- [ ] Critical - Blocking my business
|
||||
- [ ] High - Very useful
|
||||
- [ ] Medium - Nice to have
|
||||
- [ ] Low - Just an idea
|
||||
|
||||
## Willingness to Pay
|
||||
<!-- Would you upgrade your tier for this feature? -->
|
||||
- [ ] Yes, I would upgrade immediately
|
||||
- [ ] Yes, I would consider upgrading
|
||||
- [ ] No, but it would improve my experience
|
||||
- [ ] N/A - Already on Enterprise
|
||||
90
.gitea/issue_template/feature_request.yml
Normal file
90
.gitea/issue_template/feature_request.yml
Normal file
@@ -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
|
||||
@@ -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!** 🔒
|
||||
56
.gitea/issue_template/security_vulnerability.yml
Normal file
56
.gitea/issue_template/security_vulnerability.yml
Normal file
@@ -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
|
||||
@@ -1,52 +0,0 @@
|
||||
---
|
||||
name: ❓ Support Request
|
||||
about: Get help with using Evercatch
|
||||
title: '[SUPPORT] '
|
||||
labels: question
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Issue Summary
|
||||
<!-- Brief description of what you need help with -->
|
||||
|
||||
## What I'm Trying to Do
|
||||
<!-- Describe your goal -->
|
||||
|
||||
## What I've Tried
|
||||
<!-- List what you've already attempted -->
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Account Information
|
||||
- **Email**: (your account email)
|
||||
- **User ID** (if known):
|
||||
- **Subscription Tier**: Sandbox / Indie / Studio / Enterprise
|
||||
|
||||
## Relevant Documentation
|
||||
<!-- Links to docs you've read -->
|
||||
- [ ] 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
|
||||
<!-- If applicable, paste any error messages -->
|
||||
```
|
||||
Paste error here
|
||||
```
|
||||
|
||||
## Questions
|
||||
1.
|
||||
2.
|
||||
|
||||
## Screenshots
|
||||
<!-- If applicable, add 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)
|
||||
95
.gitea/issue_template/support_request.yml
Normal file
95
.gitea/issue_template/support_request.yml
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user