Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.36 KB
Raw

Contributing Guidelines

Contributions to this repository should follow the GitHub Flow git workflow. In essence, you contribute by making changes in your fork and then generating a pull request of those changes to be merged with the upstream.

How to contribute

There are three main ways to contribute to the repo:

  1. To work on the project's open issues
  2. To review the contents in the guidelines here against the contents in the original PDF and open issues where there are differences
  3. To suggest features that may improve the experience for users of the app
  4. To review any open pull requests

Getting Started

  1. Clone this repo onto your computer
  2. This project uses Yarn for package management. Download and install yarn to get started if you do not already have it
  3. Install dependencies by running yarn install
  4. Run the project by using yarn run start

Recommendations

Keep your fork synced

Several changes may be made to the repo at a time or other pull requests merged so make sure you sync the repo as frequently as is necessary to keep your repo up to date with the upstream version.