There are many ways to contribute to OpenBoxes, and not just through making changes to the source code. Here are a few examples of areas we need a considerable amount of help.
- Develop a new feature
- Patch a bug / hotfix
- Improve translations
- Improve documentation
- Write unit, integration, functional tests
Find or create an issue for the feature or bug in GitHub Issues.
Fork the openboxes/openboxes GitHub repository.
Create a branch for your changes (create a
hotfixfor bugs if working off
featurebranch for features if working off
develop). NOTE: The use of the
developprefix will help us identify which branch we need to merge your changes into.
git checkout -b hotfix/123-short-summary-of-issue git checkout -b feature/123-short-summary-of-issue
Implement your feature or hotfix in your new branch.
Write a test for your changes (if you have trouble with this step please comment in your ticket that you'd like some help). NOTE: Tests are required for features and bug fixes, but not for documentation and translation changes.
grails test-app unit: grails test-app integration:
Commit your changes
git commit -m "Implemented feature #123"
Push to your fork.
Submit a pull request.