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.
2026-02-13 15:34:23 +00:00
parent 27c69d201f
commit 8176118c0f
13 changed files with 1137 additions and 185 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,63 +1,308 @@
 # Contributing to Evercatch

-Thank you for contributing. Please read this guide before opening issues or PRs.
+Thank you for your interest in contributing to Evercatch! 🎉
+
+While Evercatch is currently **closed-source**, we welcome community contributions in several ways.

 ---

-## 🌿 Branching
+## 🐛 Bug Reports

-Branch from `main` using the format `EC-ID-short-description`.
+Found a bug? Please report it!

-```bash
-git checkout -b EC-12-implement-stripe-inbound
-```
+**Before reporting:**
+1. Search [existing issues](../../issues) to avoid duplicates
+2. Check [docs.evercatch.dev](https://docs.evercatch.dev) for solutions
+3. Verify it's reproducible
+
+**How to report:**
+1. Use our [Bug Report Template](../../issues/new?template=bug_report.md)
+2. Include clear steps to reproduce
+3. Provide environment details (tier, timestamps, event IDs)
+4. **Never include** API keys or sensitive data
+
+**What happens next:**
+- We'll acknowledge within 24-48 hours
+- We'll add appropriate labels
+- We'll investigate and provide updates
+- Critical bugs are prioritized

 ---

-## ✨ Commit Messages
+## ✨ Feature Requests

-Follow the Conventional Commits standard prefixed with the issue ID.
+Have an idea? We'd love to hear it!

-**Format:** `EC-00: <type>(scope): message`
+**Before requesting:**
+1. Check the [Public Roadmap](https://roadmap.evercatch.dev)
+2. Search [existing requests](../../issues?q=is%3Aissue+label%3Afeature)
+3. Think about the use case and impact

-| Type | Description |
-| :--- | :--- |
-| `feat` | New feature |
-| `fix` | Bug fix |
-| `docs` | Documentation |
-| `style` | Formatting |
-| `refactor` | Refactor |
-| `perf` | Performance |
-| `test` | Tests |
-| `build` | Build system |
-| `ci` | CI/CD config |
-| `chore` | Maintenance |
+**How to request:**
+1. Use our [Feature Request Template](../../issues/new?template=feature_request.md)
+2. Explain the problem it solves
+3. Describe your ideal solution
+4. Share your use case
+5. Mention which tier would benefit

-**Examples:**
- `EC-12: feat(webhooks): implement stripe inbound endpoint`
- `EC-18: fix(relay): resolve double-delivery on retry`
+**What happens next:**
+- We'll review and discuss with you
+- Popular requests get upvoted
+- We'll add to roadmap if aligned with our vision
+- You'll be notified when we start building it

 ---

-## 🔍 Pull Requests
+## 📚 Documentation

- Link the issue in your PR description
- All CI checks must pass before requesting review
- Minimum one approval required to merge
- Keep PRs focused — one feature or fix per PR
+Help us improve our docs!
+
+**Ways to contribute:**
+- Report unclear or missing documentation
+- Suggest better examples
+- Point out broken links
+- Fix typos or grammar
+
+**How to contribute:**
+1. Use our [Documentation Template](../../issues/new?template=documentation.md)
+2. Link to the specific docs page
+3. Explain what's wrong
+4. Suggest improvements

 ---

-## 🏷️ Labels
+## 🧪 Beta Testing

-Apply the appropriate labels to your issue or PR:
+Want early access to new features?

- `type:` — what kind of change is this
- `priority:` — how urgent is it
- `status:` — current state of the issue or PR
+**Join our beta program:**
+1. Sign up at [evercatch.dev/beta](https://evercatch.dev/beta)
+2. Get invited to private beta releases
+3. Test new features before they're public
+4. Provide feedback directly to the team
+
+**Beta testers get:**
+- ✨ Early access to features
+- 🎯 Direct line to product team
+- 🎁 Swag and perks
+- 🏆 Recognition in release notes

 ---

-## ❓ Questions
+## 💬 Community Support

-Open an issue with the `type: chore` label or reach out via the org README.
+Help other users in the community!
+
+**Ways to help:**
+- Answer questions in issues
+- Share your integration examples
+- Write blog posts about Evercatch
+- Create video tutorials
+
+**Recognition:**
+Top contributors get:
+- 🎖️ "Community Helper" badge
+- 💎 Free tier upgrades
+- 🎁 Swag package
+- 🌟 Featured in our newsletter
+
+---
+
+## 🔐 Security
+
+**Found a security vulnerability?**
+
+**DO NOT** open a public issue. Instead:
+
+📧 **Email:** [security@evercatch.dev](mailto:security@evercatch.dev)
+
+See our [Security Policy](SECURITY.md) for details.
+
+---
+
+## 🎯 Integration Examples
+
+Share how you're using Evercatch!
+
+**We're looking for:**
+- Code examples in different languages
+- Integration guides for specific providers
+- Creative use cases
+- Performance optimizations
+
+**How to share:**
+1. Open a [Feature Request](../../issues/new?template=feature_request.md)
+2. Label it as "integration-example"
+3. Share your code (sanitized of secrets!)
+4. Explain the use case
+
+**We'll feature the best examples on:**
+- [docs.evercatch.dev](https://docs.evercatch.dev)
+- Our blog
+- Social media
+
+---
+
+## 📝 Blog Posts & Tutorials
+
+Written about Evercatch?
+
+**Let us know!** We'll:
+- Share it on our blog
+- Promote it on social media
+- Link to it from our docs
+- Send you swag 🎁
+
+**Email:** [community@evercatch.dev](mailto:community@evercatch.dev)
+
+**Include:**
+- Link to your post
+- Brief summary
+- Your name/company
+- Preferred social handle
+
+---
+
+## 🎨 Design Feedback
+
+Got UI/UX suggestions?
+
+**We love design feedback:**
+- Dashboard improvements
+- API response formats
+- Documentation layout
+- Error messages
+
+**How to share:**
+1. Open a [Feature Request](../../issues/new?template=feature_request.md)
+2. Include screenshots or mockups
+3. Explain the improvement
+4. Share design rationale
+
+---
+
+## 💡 Best Practices
+
+### Writing Good Issues
+
+**Do:**
+- ✅ Use clear, descriptive titles
+- ✅ Include all requested template information
+- ✅ Provide context and examples
+- ✅ Be respectful and professional
+- ✅ Follow up on questions
+
+**Don't:**
+- ❌ Create duplicate issues
+- ❌ Ask multiple unrelated questions in one issue
+- ❌ Bump issues without new information
+- ❌ Include API keys or sensitive data
+- ❌ Demand features or fixes
+
+### Communication Guidelines
+
+**Be:**
+- 🤝 Respectful and professional
+- 📝 Clear and concise
+- 💭 Open to discussion
+- 🙏 Patient with response times
+- ❤️ Kind to other community members
+
+**Remember:**
+- We're a small team
+- Enterprise users get priority support
+- Free tier users may wait longer
+- Some features may not align with our roadmap
+- We appreciate your understanding
+
+---
+
+## 🏆 Recognition
+
+### Hall of Fame
+
+Top contributors get featured in our:
+- Monthly newsletter
+- Annual report
+- About page
+- Conference talks
+
+### Contributor Tiers
+
+**🥉 Bronze** (1-5 contributions)
+- Thank you in release notes
+- Digital badge
+
+**🥈 Silver** (6-15 contributions)
+- Free Indie plan (1 year)
+- Swag package
+- Featured in newsletter
+
+**🥇 Gold** (16+ contributions)
+- Free Studio plan (1 year)
+- Premium swag
+- Video call with founders
+- Listed as "Top Contributor"
+
+---
+
+## 📅 Release Process
+
+**Our schedule:**
+- 🚀 **Major releases** - Quarterly
+- 🔄 **Minor releases** - Monthly
+- 🐛 **Bug fixes** - Weekly
+- 🔥 **Hotfixes** - As needed
+
+**Stay updated:**
+- [Changelog](https://changelog.evercatch.dev)
+- [Twitter](https://twitter.com/evercatch)
+- [Newsletter](https://evercatch.dev/newsletter)
+
+---
+
+## 🤝 Code of Conduct
+
+All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+**Summary:**
+- Be respectful and inclusive
+- No harassment or discrimination
+- Focus on constructive feedback
+- Help create a welcoming community
+
+**Violations:** Report to [conduct@evercatch.dev](mailto:conduct@evercatch.dev)
+
+---
+
+## ❓ Questions?
+
+**Not sure where to start?**
+
+- 📚 Read the [docs](https://docs.evercatch.dev)
+- 💬 Ask in [issues](../../issues)
+- 📧 Email [community@evercatch.dev](mailto:community@evercatch.dev)
+- 🐦 Tweet [@evercatch](https://twitter.com/evercatch)
+
+---
+
+## 🎁 Thank You!
+
+Every contribution matters, no matter how small:
+- 🐛 Bug reports help us improve
+- ✨ Feature ideas shape our roadmap  
+- 📚 Documentation helps other users
+- 💬 Community support makes everyone's experience better
+
+**We appreciate you!** ❤️
+
+---
+
+<p align="center">
+  <strong>Built with ❤️ by developers, for developers</strong>
+  <br/>
+  <a href="https://evercatch.dev">Website</a> •
+  <a href="https://docs.evercatch.dev">Docs</a> •
+  <a href="https://roadmap.evercatch.dev">Roadmap</a> •
+  <a href="https://status.evercatch.dev">Status</a>
+</p>