First of all, thank you for contributing!

Here are a few rules to follow in order to ease code reviews and merging:

One may ask you to squash your commits too. This is used to "clean" your pull request before merging it (we don't want commits such as fix tests, fix 2, fix 3, etc.).

When creating your pull request on GitHub, please write a description which gives the context and/or explains why you are creating it.


To be able to preview Couscous own website on your machine, you will need the following tools installed:

  • Bower:

    $ npm install -g bower
  • Less compiler:

    $ npm install -g less less-plugin-clean-css
  • Phar generation enabled in php.ini:

    phar.readonly = Off

Then you can run bin/couscous preview.

Building the phar

To generate the phar yourself, you need to allow Phar generation in your php.ini (phar.readonly = Off).

You also need to be able to use the sha1sum cli tool.

The procedure is then quite simple, check out the repository and:

$ composer update
$ bin/compile

The phar is generated as bin/couscous.phar.

Releasing a new version

Instructions for maintainers:

$ composer update
$ bin/compile
$ cp bin/couscous.* website/
$ bin/couscous deploy