CONTRIBUTING.md

Developing

• Clone a copy of this project
• Change into the project directory from the terminal and install dependencies via npm install.
• Replace all the credentials found in index with your own. Read Getting started to learn more.
• Run npm start to start a server on http://localhost:9966/.

Tests

To run tests locally, you'll need create a writeable file called .env.sh with the following contents:

export GitHubToken="GITHUB TOKEN"
export account="ACCOUNT NAME"
export repo="REPO NAME"
export team="TEAM FILENAME"
export form="FORM FILENAME"

Note: you can optionally add export branch="BRANCH NAME" if test data lies in a specific branch.

Run tests via

npm run test-local

Deploying

• npm run build
• Add entry to CHANGELOG
• Update the version key in package.json
• Commit and push
• git tag -a vX.X.X -m 'vX.X.X'
• git push --tags
• npm publish