Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 1.71 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • Coding Standard - The easiest way to apply the conventions just run composer syntax. You can also try composer syntax-fix for fixing errors automatically.

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • Create feature branches - Don't ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Running Syntax Checker

$ composer syntax

Running Tests

$ composer test

Working with assets

  • You should never modify files in /assets/dist/ folder
  • Just install build dependencies over npm
$ npm install
  • Run watcher and edit any of *.scss or *.js file.
$ npm run watch

Tip: For nerds only!

  • You should set pre-commit hook which will trigger composer syntax and composer test before each commit.
  • How to install it? Just run exactly command bellow in root of repository:
$ ln -s ../../pre-commit.sh .git/hooks/pre-commit

Happy coding!