Puranjay Savar Mattas
8176118c0f
- 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.
6.9 KiB
Contributing to Evercatch
Thank you for your interest in contributing to Evercatch! 🎉
While Evercatch is currently closed-source, we welcome community contributions in several ways.
🐛 Bug Reports
Found a bug? Please report it!
Before reporting:
- Search existing issues to avoid duplicates
- Check docs.evercatch.dev for solutions
- Verify it's reproducible
How to report:
- Use our Bug Report Template
- Include clear steps to reproduce
- Provide environment details (tier, timestamps, event IDs)
- 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
✨ Feature Requests
Have an idea? We'd love to hear it!
Before requesting:
- Check the Public Roadmap
- Search existing requests
- Think about the use case and impact
How to request:
- Use our Feature Request Template
- Explain the problem it solves
- Describe your ideal solution
- Share your use case
- Mention which tier would benefit
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
📚 Documentation
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:
- Use our Documentation Template
- Link to the specific docs page
- Explain what's wrong
- Suggest improvements
🧪 Beta Testing
Want early access to new features?
Join our beta program:
- Sign up at evercatch.dev/beta
- Get invited to private beta releases
- Test new features before they're public
- 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
💬 Community Support
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
See our Security Policy 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:
- Open a Feature Request
- Label it as "integration-example"
- Share your code (sanitized of secrets!)
- Explain the use case
We'll feature the best examples on:
- 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
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:
- Open a Feature Request
- Include screenshots or mockups
- Explain the improvement
- 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:
🤝 Code of Conduct
All contributors must follow our Code of Conduct.
Summary:
- Be respectful and inclusive
- No harassment or discrimination
- Focus on constructive feedback
- Help create a welcoming community
Violations: Report to conduct@evercatch.dev
❓ Questions?
Not sure where to start?
- 📚 Read the docs
- 💬 Ask in issues
- 📧 Email community@evercatch.dev
- 🐦 Tweet @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! ❤️
Built with ❤️ by developers, for developers
Website •
Docs •
Roadmap •
Status