Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

26 lines (20 loc) · 1.17 KB

How to get setup (if you're using the docker image you can skip this:

  • grab the repo
  • run the tests with npm test to make sure your environment is setup properly. If you don't have it already, install mongodb. You could dev using and externally hosten mongo db if you want, but it's a pain.

Here are the technologies to be familiar with:

Don't make changes to the compiled CSS. It's compiled from less; please edit that and then run make less before you submit. To simplify things for development, install watch and then run make watch. It will then check for changes to the .less files every second, and compile if needed.

Before submitting pull requests, please run npm test to make sure you didn't break anything. If you're adding or changing backend functionality, include tests.

If you're adding or changing the front-end, please include one or more explanitory screenshots in the pull request.