Thank you for your interest in contributing to FinalCast-OpenSource! 💜
We’re excited to have you join us in making FinalCast better — whether by improving code, reporting bugs, adding documentation, or suggesting features.
FinalCast is an open-source full-stack podcasting and video conversation platform built on the MERN stack, WebRTC, and FFmpeg. It follows an automated Record → Render → Release workflow for creators.
Please read these guidelines carefully before contributing.
- How Can I Contribute?
- Getting Started
- Project Structure
- Reporting Issues
- Pull Request Process
- Code Style Guidelines
- Commit Message Convention
- Communication & Conduct
- Branching Strategy
- License
You can contribute in many ways:
- 🐞 Reporting bugs or crashes
- ✨ Suggesting new features or improvements
- 🧠 Adding backend or frontend features
- 📝 Improving documentation or comments
- 🔧 Refactoring or optimizing existing code
Contributions from beginners are highly encouraged.
Click the Fork button at the top right of this repository.
git clone https://github.com/<your-username>/FinalCast-OpenSource.git
cd FinalCast-OpenSourcecd backend
npm installcd ../frontend
npm installgit checkout -b feature/your-feature-nameFinalCast-OpenSource/
│
├── backend/
├── frontend/
├── docs/
├── README.md
└── LICENSE
Before opening a new issue:
- Search existing issues
- Provide reproducible steps
- Attach logs/screenshots if needed
- Branch from
main - Keep PRs small and focused
- Reference related issues
- Be open to review feedback
- Do not over-engineer
- Keep logic simple and readable
- Follow existing patterns
- Add minimal comments only when needed
feat: add new feature
fix: resolve bug
docs: update documentation
refactor: simplify code
Be respectful and inclusive.
Harassment or toxic behavior will not be tolerated.
- master → stable
- feature/* → new features
- fix/* → bug fixes
By contributing, you agree that your contributions fall under the project license.
Happy contributing! 🚀