Add complete community documentation
- README.md: Product overview + issue tracker landing - SECURITY.md: Responsible disclosure policy - CODE_OF_CONDUCT.md: Community guidelines - CONTRIBUTING.md: How to contribute - SUPPORT.md: Comprehensive support guide - Issue templates: Bug, feature, support, docs, security All references updated to evercatch.dev domain.
This commit is contained in:
46
.gitea/issue_template/bug_report.md
Normal file
46
.gitea/issue_template/bug_report.md
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
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.
|
||||
45
.gitea/issue_template/documentation.md
Normal file
45
.gitea/issue_template/documentation.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
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
|
||||
54
.gitea/issue_template/feature_request.md
Normal file
54
.gitea/issue_template/feature_request.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
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
|
||||
44
.gitea/issue_template/security_vulnerability.md
Normal file
44
.gitea/issue_template/security_vulnerability.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
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!** 🔒
|
||||
52
.gitea/issue_template/support_request.md
Normal file
52
.gitea/issue_template/support_request.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
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)
|
||||
Reference in New Issue
Block a user