- Fork the repo.
- Install dependencies:
composer install. - Create branch, e.g. feature-foo or bugfix-bar.
- Make changes.
- If you are adding functionality or fixing a bug - add a test!
- Fix project itself:
php php-cs-fixer fix. - Regenerate readme:
php php-cs-fixer readme > README.rst. Do not modify README.rst manually! - Check if tests pass:
phpunit.
You can do some things to increase the chance that your pull request is accepted the first time:
- Submit one pull request per fix or feature.
- If your changes are not up to date - rebase your branch on master.
- Follow the conventions used in the project.
- Remember about tests and documentation.
- Don't bump version.
There is a cookbook with basic instructions on how to build a new fixer. Consider reading it before opening a PR.
- PSR-0: Autoloading Standard
- PSR-1: Basic Coding Standard
- PSR-2: Coding Style Guide
- Symfony Coding Standards
- Keep the order of class elements: static properties, instance properties, constructor (or setUp for PHPUnit), destructor (or tearDown for PHPUnit), static methods, instance methods, magic static methods, magic instance methods.