Skip to content

Contributing

James Wright edited this page Mar 19, 2020 · 5 revisions

I hope that you find Valimate useful. All contributions are appreciated an encouraged, and are reviewed and accepted via GitHub's pull request mechanism.

Running locally

Once you've forked and cloned the project, run npm i to install the development and test dependencies. To run the unit and functional tests, run npm test. The functional test queries the URLs found in the repository's valimate.json file.

Code formatting

You should ensure your code is formatted consistently with the rest of the project by running npm run format.

Branching

For optimal organisation, please:

  • lowercase your branch names and use hyphens for token separation
  • use the branch name prefix feature/ for new features, or issue/ for issues
Clone this wiki locally