Contributing Guide¶
Thanks for your interest in contributing! 🚀
We welcome bug reports, feature requests, and improvements.
🧑💻 Development Setup¶
-
Clone the repository: git clone https://github.com/Zomato/pulse-droid
-
Open in Android Studio
-
Sync Gradle and build the project
🌿 Branching Strategy¶
We follow a structured branching model:
- master → Production-ready code
- dev → Active development branch
- feature/* → New features
- bug/* → Bug fixes
🔄 Contribution Workflow¶
- Fork the repository
- Create a new branch from
dev: git checkout -b feature/your-feature-name - Make your changes
- Commit with a clear message
- Push to your fork
- Create a Pull Request (PR) to
dev
🧾 Commit Message Guidelines¶
Follow this format:
type: short description
Examples: - feat: add mqtt retry mechanism - fix: resolve connection timeout issue - refactor: optimize reconnect logic
📦 Code Guidelines¶
- Follow Kotlin best practices
- Keep code modular and testable
- Add comments for complex logic
- Maintain backward compatibility
✅ Pull Request Checklist¶
Before submitting a PR:
- [ ] Code compiles successfully
- [ ] No unnecessary changes included
- [ ] Proper description added
- [ ] Related issue linked (if any)
- [ ] Tested locally
🔍 Review Process¶
- All changes must go through PR
- Code owners will review changes
- PR will be merged only after approval
🐛 Reporting Issues¶
Please include:
- Clear description
- Steps to reproduce
- Expected vs actual behavior
- Logs/screenshots (if applicable)
🚫 What We Don’t Accept¶
- Breaking changes without discussion
- Unrelated large PRs
- Poorly documented changes
🤝 Code of Conduct¶
Be respectful and constructive.
We aim to maintain a healthy open-source community.
Thanks for contributing ❤️