From 9fd7ef6d1d30fb77b80b82553faf364907e22637 Mon Sep 17 00:00:00 2001 From: Ain Tohvri Date: Tue, 9 May 2017 13:21:30 +0200 Subject: [PATCH] Resolve #12 Contribution guidelines [ci skip] --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ README.md | 23 +---------------------- 2 files changed, 38 insertions(+), 22 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4ca9784 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing + +## Important notes +Please don't edit files in the `dist` subdirectory as they are generated via Grunt. You'll find source code in the `src` subdirectory! + +### Code style +See [JavaScript coding conventions](http://conventions.interactive-pioneers.com/JavaScript) of Interactive Pioneers. + +## Modifying the code + +1. Ensure that you have [Node.js](http://nodejs.org/) 6.2.0 installed. +1. Fork and clone the repo. +1. Run `npm i` to install all dependencies. +1. Run `npm start` to watch this project for changes and QA automatically as code is changed. + +## Submitting pull requests + +1. Create a new branch, please don't work in your `master` branch directly. +1. Add failing tests for the change you want to make. Run `npm run grunt mocha` to see the tests fail. +1. Fix stuff. +1. Run `npm test` to see if QA tasks pass. Repeat steps 2-4 until done. +1. Update the documentation to reflect any changes. +1. Push to your fork and submit a pull request. + +## Bug reports, suggestions + +- File all your issues, feature requests [here](https://github.com/interactive-pioneers/iptools-jquery-tooltip/issues) +- If filing a bug report, follow the convention of _Steps to reproduce_ / _What happens?_ / _What should happen?_ +- __If you're a developer, write a failing test instead of a bug report__ and send a Pull Request. See [Submitting pull requests](#submitting-pull-requests). + +## Tips + +Following tasks are there to help with development: + +- `npm start` listens to tests and source, reruns tests +- `npm test` run QA task that includes tests and JSHint +- `npm run grunt build` build and minify source to dist/ diff --git a/README.md b/README.md index 89d0514..ced1601 100644 --- a/README.md +++ b/README.md @@ -62,28 +62,7 @@ tooltipClassActiveModifier| `--active` | string | Modifier th ## Contributions -### Bug reports, suggestions - -- File all your issues, feature requests [here](https://github.com/interactive-pioneers/iptools-jquery-tooltip/issues) -- If filing a bug report, follow the convention of _Steps to reproduce_ / _What happens?_ / _What should happen?_ -- __If you're a developer, write a failing test instead of a bug report__ and send a Pull Request - -### Code - -1. Fork it ( https://github.com/[my-github-username]/iptools-jquery-tooltip/fork ) -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Develop your feature by concepts of [TDD](http://en.wikipedia.org/wiki/Test-driven_development), see [Tips](#tips) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request - -### Tips - -Following tasks are there to help with development: - -- `grunt watch:bdd` listens to tests and source, reruns tests -- `grunt qa` run QA task that includes tests and JSHint -- `grunt build` minify source to dist/ +See [CONTRIBUTING.md](CONTRIBUTING.md). ## Licence Copyright © 2015 Interactive Pioneers GmbH. Licenced under [GPLv3](LICENSE).