Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.21 KB
Raw

Contributing to Vireo

Getting Started

To begin development on Vireo, make sure to start by forking the repository. Make sure to run npm install at the root of the repository once you have cloned it locally to get the npm packages necessary for running the tests.

Adding a Feature or Fixing a Bug

  1. Make your changes
  • Run the tests (see the README for more information about testing)
  • Add any additional tests if needed to test your fix or feature
  • Submit a pull request to the proper branch (see below)
  • The TravisCI Build will pull your changes and validate that all of the tests pass before allowing the pull request to be merged.
  • If the CI build passes, your pull request can now be merged. If not, the request will not be merged until the CI passes.

(The master branch should be considered stable and new feature development will be done on the incoming branch.)

Updating your current branch/fork with upstream/master

If your branch is behind the master/incoming branch (and you have no local changes that conflict), you can merge the upstream changes into your branch:

git pull upstream master