How to contribute

Thanks for considering to contribute to the lean package validator.

Setting up a development environment

To set up a development environment, please follow the next shown instructions.

git clone git@github.com:raphaelstolt/lean-package-validator.git
composer install
// implement your changes
composer pre-commit-check

Please follow these guidelines:

All code MUST follow the PSR-2 coding standard. Please see PSR-2 for more details.
Coding standard compliance MUST be ensured before committing or opening pull requests by running composer lpv:cs-fix or composer lpv:cs-lint in the root directory of this repository.
Commits MUST use the provided commit message template, which follows the rules described by Chris Beams. It can be configured via composer lpv:configure-commit-template prior to committing.
All upstreamed contributions MUST use feature / topic branches to ease merging.
Please run composer lpv:pre-commit-check before opening a pull request.