Skip to content

Contributing

albertmoreno edited this page Aug 18, 2015 · 11 revisions

Contributions are welcome. We accept contributions via Pull Requests on Github.

Building Javascript files

The javascript source code is located in assets/js folder and mixed with their dependencies in the file public/js/jsvalidation.js. To make contributions don't modify the file public/js/jsvalidation.js. Make the changes in the assets/js/*.js files and compile the code with Laravel Elixir.

All Javascript dependencies are managed with Bower. They are mixed and minimized in a public/js folder using Laravel Elixir.

Before to build the Javascript files you need to have Laravel Elixir installed. You can see in the Laravel Documentation how to setup your environment.

To build the files, install bower packages and use Gulp to mix them.

bower update
gulp

This will generate public/js/jsvalidation.js file with assets files mixed.

Pull Requests

  • PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

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

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • 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.

Happy coding!

Clone this wiki locally