Skip to content

Latest commit

 

History

History
22 lines (11 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

22 lines (11 loc) · 1.29 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via an existing relevant issue or by opening a new issue. This will allow people working on the same or overlappign features to be aware of each other's intentions, and maybe work together on the pull request.

To contribute, fork the project and make a new branch for each feature/bug fix you would like to contribute. Then, submit a pull request following the guidelines below.

Pull Request Guidelines

  1. Pull requests should be made against the relevant feature branch if it exists, or to the dev branch (see description below) if no relevant feature branch exists. Do not use the master branch as base for pull requests.

  2. Each pull request should contain a single feature/bug fix/contribution.

  3. Be mindful of caching via service workers. Increase versions when appropriate.

  4. If your pull request is related to an existing pull request or an issue, reference the issue or pull request as part of your PR message (see how to do this)

Branch Description

  • dev: is the main development branch, which may contain unstable code.

  • master: is the main branch, and should contain the latest code that is considered stable.