Contributing

May 20, 2018 ยท View on GitHub

As long as your pull request doesn't break the app in any way or conflict with an ongoing change (check the open issues first or send me an email to make sure this doesn't happen), it will likely be accepted. I have a lot of projects and may not get around to reviewing pull requests right away. If you have contributed to this project before and would like to be added to this repository as a collaborator, feel free to send me an email and ask.

Branches

I am using the develop branch for all changes that won't be immediately available in a new release, with the exception of the README and similar files (like this one). Most PRs should be made to the develop branch. The only reason that a PR should be made to master is when there is a typo/inconsistency in the README or something similar. If you make a PR to master that changes something other than a .md file, I will stare at my screen and make dying lizard noises for approximately 10 minutes before politely asking you to change the branch. Thank you.

Build Instructions

This project has certian icon sets and fonts missing from the open source repository, as they are under a different license. This will not affect how you compile the project, as I am using a somewhat hacky method of getting the resource ids for these items from strings at runtime. Everything else should work as normal.

To build the project from the command line, see Build Your App from the Command Line (android docs).