From 44943633a413e03ac70df189f9098436a363be93 Mon Sep 17 00:00:00 2001 From: Josh Johnson Date: Wed, 5 Jul 2017 09:11:23 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a9667da --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributions +In lieu of a formal styleguide, take care to maintain the existing coding style ensuring there are no linting errors. Add unit tests for any new or changed functionality. Lint and test your code using the npm scripts below: + +### NPM tasks +| Task | Usage | +| -------------------- | ------------------------------------------------------------ | +| `npm run start` | Fire up local server for development | +| `npm run test` | Run sequence of tests once | +| `npm run test:watch` | Fire up test server and re-test on file change | +| `npm run js:build` | Compile Choices to an uglified JavaScript file | +| `npm run css:watch` | Watch SCSS files for changes. On a change, run build process | +| `npm run css:build` | Compile, minify and prefix SCSS files to CSS | + +## Pull requests +When submitting a pull request that resolves a bug, feel free to use the following template: + +```md +## This is the problem: + +## Steps to reproduce: + +## This is my solution: +```