👋 Welcome! Thanks for expressing an interest in contributing to the Kodeco app.
Once you have the project open in Android Studio, select the Emitron
scheme and use Ctrl + Shift + C
to run the tests with coverage.
Don't forget to add tests for any new features you add or contribute to.
If you are fixing a single GitHub issue in particular, please add a test named testGH<issue number>
to ensure that your fix is working. This will also help prevent regression.
Additionally, when creating pull requests, use the following naming scheme EMA-XYZ-ticket-description
where:
EMA
represents the Emitron Android projectXYZ
is the ticket numberticket-description
is usually the same as the ticket title, unless the title is confusing or too long.- Example:
EMA-328-enable-app-usage-while-in-debug-mode
.
emitron interfaces with the Kodeco API to retrieve data. You can find API documentation here:
https://raywenderlich.docs.apiary.io
If you would like to suggest new features, please open an issue for discussion, and include a development proposal. Although the app is open source, Razeware reserves the right to direct new feature development, and to modify, request changes to, or reject feature proposals as it sees fit.
Thanks! Your work on this app will help support our worldwide community of mobile developers as they strive to improve their skills in the industry.