16 lines
920 B
Markdown
16 lines
920 B
Markdown
|
# Contributing to Robo
|
||
|
|
|
||
|
|
Thank you for your interest in contributing to Robo! Here are some of the guidelines you should follow to make the most of your efforts:
|
||
|
|
|
||
|
|
## Code Style Guidelines
|
||
|
|
|
||
|
|
Robo adheres to the [PSR-2 Coding Style Guide](http://www.php-fig.org/psr/psr-2/) for PHP code. An `.editorconfig` file is included with the repository to help you get up and running quickly. Most modern editors support this standard, but if yours does not or you would like to configure your editor manually, follow the guidelines in the document linked above.
|
||
|
|
|
||
|
|
You can run the PHP Codesniffer on your work using a convenient command built into this project's own `RoboFile.php`:
|
||
|
|
```
|
||
|
|
robo sniff src/Foo.php --autofix
|
||
|
|
```
|
||
|
|
The above will run the PHP Codesniffer on the `src/Foo.php` file and automatically correct variances from the PSR-2 standard. Please ensure all contributions are compliant _before_ submitting a pull request.
|
||
|
|
|
||
|
|
|