Contributing to SilentCast
Thank you for your interest in contributing to SilentCast! This guide will help you get started.
Quick Links
Code of Conduct
By participating in this project, you agree to be respectful, inclusive, and constructive in all interactions.
How to Contribute
Reporting Issues
Before creating an issue:
- Search existing issues to avoid duplicates
- Use issue templates when available
- Include relevant information:
- SilentCast version
- Operating system
- Steps to reproduce
- Error messages
Suggesting Features
- Check the roadmap and existing issues
- Open a discussion first
- Explain the use case clearly
- Be open to alternatives
Contributing Code
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
Development Setup
See the API Contributing Guide for detailed development setup and coding standards.
Quick Start
bash
# Fork and clone
git clone https://github.com/YOUR-USERNAME/silentcast.git
cd silentcast
# Create branch
git checkout -b feature/your-feature
# Make changes and test
make test
# Commit
git commit -m "feat: add amazing feature"
# Push and create PR
git push origin feature/your-feature
Getting Help
- Development questions: Open a GitHub Discussion
- Bug in your PR: Update the PR with fixes
- Need guidance: Ask in PR comments
Thank you for contributing! 🎉