Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (28 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.4 KB
Raw

Contributing Guide

You will need:

  • Node.js and npm
  • webpack

Windows users will need additional setup to enable build capabilities in NPM. From an administrative command window:

npm install --global --production windows-build-tools

Getting started

  1. Fork the project
  2. Clone your forked project by running git clone git@github.com:{ YOUR_USERNAME }/shepherd.git
  3. Run npm install to install node modules
  4. Test that you can build the source by moving/renaming the existing dist directory and running npm run build
  5. Assuming everything went well, you should now have a dist directory that matches the one you moved in step 4

Writing code!

We use webpack to facilitate things like transpilation, minification, etc. so you can focus on writing relevant code. If there is a fix or feature you would like to contribute, we ask that you take the following steps:

  1. Most of the editable code lives in the src directory while built code will end up in the dist directory upon running npm run build.

  2. Provide a thoughtful commit message and push your changes to your fork using git push origin master (assuming your forked project is using origin for the remote name and you are on the master branch).

  3. Open a Pull Request on GitHub with a description of your changes.

Testing

All PRs, that change code functionality, are required to have accompanying tests.