Contribute to mTHMMY

Thank you for your interest in contributing to mTHMMY! This guide details how to contribute to mTHMMY in a way that is efficient for everyone.

Security vulnerability disclosure

Important! Instead of creating publicly viewable issues for suspected security vulnerabilities, please report them in private to contact@thmmy.gr.

I want to contribute!

There are many ways of contributing to mTHMMY:

Simply using the latest release version from Google Play (anonymous reports are sent automatically)
Joining our Discord server
Submitting bugs and ideas to our issue tracker
Forking mTHMMY and submitting pull requests
Joining our core team
Contacting us by email at contact@thmmy.gr

Issue tracker

For bugs and improvements we use GitHub’s issue tracking. Before creating a new issue make sure to search the tracker for similar ones.

Compiling

Due to the app's integration with Firebase, a google-services.json file is required inside the app/src/debug directory (which you have to create). To get one, either set up your own Firebase project (with or without a self hosted backend), or ask us to provide you the one we use for development.

Pull requests

Pull requests with fixes and improvements to mTHMMY are most welcome. Any developer that wants to work independently from the core team can simply follow the workflow below to make a pull request (PR):

Fork the project into your personal space on Github
Create a feature branch, away from develop
Push the commit(s) to your fork
Create a PR targeting develop at mTHMMY
Fill the PR title describing the change you want to make
Fill the PR description with a brief motive for your change and the method you used to achieve it
Submit the PR.