Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Submitting a Pull Request

Adam Izraelevitz edited this page Sep 15, 2016 · 5 revisions

So, you want to submit a pull request (PR), eh? Awesome. You are awesome. High five.

But... before you hit that green submit button, there are a few things that would be great to adhere to:

Guidelines

  • Small PR == Easy to understand PR == Fast to review PR == Happy Reviewer :)

  • Bugfix must be accompanied with a corresponding test case demonstrating the bug (and it must pass).

  • Feature addition must be accompanied with a suite of tests

  • Separate functional changes from style changes (make them two separate PR's)

  • Please assign a reviewer to your case. The following people have permission to review PR's: @azidar, @jackkoenig, @donggyukim, @aswaterman.

Thanks!!