Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (18 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

35 lines (18 loc) · 1.1 KB

We ❤ pull requests.

  1. Fork the repo.

  2. Install node_modules by running npm install.

  3. Enable the pre-commit-hook by running grunt githooks once.

  4. Add commit.template to .git/config by running git config commit.template ./.gitmessage once.

  5. Happy coding ...

  6. Use JShint on your code, either with .jshintrc or grunt jshint. The grunt task is automatically run on grunt, grunt build, grunt dev, grunt watch and of course as a pre-commit-hook.

  7. Push to your fork and submit a pull request.

  8. Please give us some time to review your pull request.

Syntax

  • .editorconfig for text editors like Sublime Text. Read more at editorconfig.org.

  • settings/jetbrains.jar for WebStorm, PHPStorm or other JetBrains IDEs.

  • Four spaces.

  • No tabs.

  • No trailing whitespace.

  • Empty new line at the end of a file.

  • Follow the conventions you see used in the source already.