Paraunit comes with a containerized environment which makes contributing really easy. The project adopted Docker Compose and Docker as container technology, you can find an useful guide for the installation process here and here.
The container already has Composer installed globally, and OhMyZsh installed as shell for some nice autocompletion features.
To start contributing:
- Clone the repo (or your fork):
git clone git@github.com:facile-it/paraunit.git
- Move inside the repo folder:
cd paraunit
- Open a shell, which will build the container as preparation:
make shell
Keep in mind that the build process will be cached by Docker, so it will be slow only the first time.
- Now you are inside the container! You should install all the dependencies:
composer install
- If you want, you can launch the testsuite to check if it's all ready! (the shell has
./binin the$PATHenv variable)
phpunit
And now you're ready! You should always use git commands (pull/commit/push) outside the container, since it does not have your GitHub credentials available.
We follow STRICTLY PSR-1 and PSR-2:
- https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
- https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
Also, this project uses the Facile.it codestyle package, and requires stricter rules.
The code style is checked in the Travis CS build; you can check it locally with the composer cs-check command, and fix
automatically all the issues with composer cs-fix; please do not commit badly formatted code!
Paraunit has a Travis build integration in place: every time you open a PR (or each time you commit something, if you enable Travis on your account/fork) it will run all the tests to check if it's all ok!
We also have other integrations in place that runs on every PR and every commit on the master branch; namely:
We provide the composer.lock file with the project. This is due to the fact that a contributor shouldn't stumble on build failures that aren't caused by his contribution itself, and have a stable and defined set of dependencies that he can use to start with; the lock file is never considered when installing Paraunit as a dependency, so it's useful only in the Travis build and in the local dev environment.
To better understand this approach, see:
- Same approach is being applied to ZendFramework components
- @rdohms talk about Composer, especially at minute 34:56
- Twitter discussion