Skip to content
This repository has been archived by the owner on Jan 11, 2021. It is now read-only.

Contributing by code

Jump to bottom
Alex Styl edited this page Feb 5, 2017 · 1 revision

Creating Pull Requests (PR)

The repo contains two main branches:

  • master which contains all changes currently available to the Play Store.
  • develop which contains all changes to be uploaded in the next version of Memento.
  1. Create a branch from develop.
  2. Make any modifications required.
  3. When done, open a PR of that branch against develop.

Things to consider

Consider testing the code you push. Of course there are some things that cannot be Tested either because of an external source (Android framework, libs etc) or because the class might not have been designed for testing when it was written (refactoring PRs more than welcome 😜 ). Most of the cases though you should write tests for your classes so that future contributors know how to your class and not break the existing behavior of the code.

Do not create huge PRs. If a PR grows big, make sure to create a new branch with those changes, and create a PR against your initial feature branch. The bigger the PR, the less chances of it getting merged on time.

Keep your commit messages short and descriptive. A good guide on How to Write a Git Commit Message can be found here and I strongly encourage you to use that conventions.

Clone this wiki locally