Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.27 KB

CONTRIBUTING

This bundle was originally created for M6Web projects purpose. As we strongly believe in open source, we share it to you.

If you want to learn more about our opinion on open source, you can read the OSS article on our website.

Developing

The features available for now are only those we need, but you're welcome to open an issue or pull-request if you need more.

To ensure good code quality, we use our awesome tool "coke" to check there is no coding standards violations. We use Symfony2 coding standards.

To execute coke, you need to install dependencies in dev mode

composer install --dev

And you can launch coke

./vendor/bin/coke

Testing

This bundle is tested with atoum.

To launch tests, you need to install dependencies in dev mode

composer install --dev

And you can now launch tests

./vendor/bin/atoum

Pull-request

If you are currently reading this section, you are a really good guy who share our vision about open source.

So, we don't want to harass you with tons of constraints. There is only 2 things we care about :

  • testing
  • coding standards