Skip to content
This repository has been archived by the owner on Sep 27, 2018. It is now read-only.

Latest commit

 

History

History
37 lines (22 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 1.3 KB

How to contribute

By contributing to this project, you agree to the license terms of the project.

In brief, contributing involves the following process:

  1. Clone the repository
  2. Create a branch
  3. ??? (Make changes?)
  4. Push the changes to GitHub
  5. Open a Pull Request

The development process

All development happens on GitHub—there exists the possibility of brainstorming happening outside of GitHub, but an attempt should be made to convey all design decisions in a GitHub issue or Pull Request.

master should be stable

The master branch should always contain a stable version of the project, with (passing) tests, and decent test coverage.

Issues

Issue should be used liberally. Example usage:

  • Brainstorming and ideas
  • General discussion
  • Actual issues (e.g. bugs)

Pull Requests

(See also: "master should be stable" above for information about branches.)

Pull Requests are the means by which branches are merged into master. Open a Pull Request and describe what changes are being introduced.

Style Guide

To be described—try to keep with the style of the document.