# 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:** 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 --- ## โœจ Feature Requests Have an idea? We'd love to hear it! **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 **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 **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:** 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 --- ## ๐Ÿงช Beta Testing Want early access to new features? **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 --- ## ๐Ÿ’ฌ 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](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!** โค๏ธ ---

Built with โค๏ธ by developers, for developers
Website โ€ข Docs โ€ข Roadmap โ€ข Status