Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 2.16 KB
Raw

Contributing

Submitting issues

  1. Search in the Github issues, if a similar issue has already been filed. If so, please contribute to this issue.
  2. On opening a new issue on Github, add a descriptive title describing in a few words your problem. Think of the terms you would have searched for to find this issue.
  3. Leave a reproducible list of steps leading to the error.
  4. If possible add the Node and NPM version you ware using as well as the OS.

See the issue template on how to file an issue.

Setup for development

You will need:

  1. A Github account and Git
  2. NodeJs with NPM installed
  3. Gulp installed globally
  4. ESLint installed globally
  5. Nodeunit installed globally

For Gulp, ESLint and Nodeunit call npm install -g gulp-cli eslint nodeunit from command line.

Making changes

  1. Fork the repository on GitHub
  2. Checkout your new repository and run npm install.
  3. Create a new feature branch from master branch, like feature/my-cool-feature.
  4. Start the Gulp watcher via gulp watch and start developing. Coding guidelines will be enforced by Gulp. See the development documentation for details.
  5. If you are really nice you will supply a test for stuff you coded.
  6. Add a line to the CHANGELOG.md to tell people what you did in your feature.
  7. Commit with a meaningful commit message (e.g. the line you put into CHANGELOG.md) & push to your repository.
  8. Run npm test. Be sure that all tests pass before proceeding any further.
  9. Submit a pull request.

Emojis for CHANGELOG.md

  • 🎁 :gift: New feature
  • 💊 :pill: Bugfix, repairing a broken functionality
  • 💣 :bomb: Possibly breaking change, needs further explanation

Further reading