Thank you for your interest in contributing to our open source reference application! We're excited to have you join our community and help improve this project.
Before you begin, please review the following:
- Read our Code of Conduct to understand our community standards.
- Check the README.md for an overview of the project and setup instructions.
- Browse the open issues to see what needs attention.
We always welcome feedback, if you've seen something that isn't quite right or you have a suggestion for a new feature, please go ahead and open an issue in this project. Select the appropriate template and include as much information as you have, it really helps.
We're always open to pull requests, but these should be small and clearly described so that we can understand what you're trying to do. Feel free to open an issue first and get some discussion going.
When you're ready to start coding, fork this repository to your own GitHub account and make your changes in a new branch based on develop. Once you're happy, open a pull request to merge into develop and explain what the change is and why you think we should include it in our project.
Our main branch is the evergreen source of truth for the Vonage Video API Reference App for Android. However, all new development should be done in the develop branch. Contributions should be made by branching off develop, and pull requests should be submitted against develop. Periodically, develop will be merged into main as a batch.
Internally, we use Jira for issue tracking. Issue and feature branches use the format DEVELOPERNAME/TICKETNUMBER-SHORTDESCRIPTION e.g. alicesmith/VIDCS-123-fix-broken-icon. If you'd like to contribute a pull request, please use a branch on your fork with a descriptive name e.g. fix-broken-icon.
Release versions use the format rc-RELEASENUMBER number, e.g. rc-1.0.0. We use semantic versioning for our releases.