Contributing Guidelines

March 8, 2020 ยท View on GitHub

First of all, thanks for your interest in contributing! Please start by checking out the current Issues and feel free to join in on the discussion.

We want to make contributing to this project as easy as possible, whether it's:

  • Revising content
  • Reporting a bug
  • Discussing the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

If you have a new idea for a change, please open up a new issue and discuss the change with the owners of the repository.

Pull Request Process

Here are the general steps to contributing code to this repository, adapted from here.

  1. First, fork the repo and clone it to your computer (+/- add upstream remote).
  2. Then, create a topic-based branch off of master.
  3. Make some commits to improve the project.
  4. Push your changes to your forked GitHub project.
  5. Open a Pull Request on Github to the original repo.
  6. Discuss, and optionally continue committing.
  7. Project Owner merges or closes the Pull Request
  8. Sync the updated master back to your fork.
  9. When project owner pushes out an app update, the code on master gets merged to release.