deployer/.github/CONTRIBUTING.md
2017-05-15 12:34:32 +02:00

31 lines
1.1 KiB
Markdown

# Contributing
Thank you for considering contributing to Deployer. Please make sure to read the following sections if you plan on submitting new issues or pull requests.
## Bug
In order for us to provide you with help as fast as possible, please make sure to include the following when reporting bugs.
* Deployer version
* PHP version
* Deployment target(s) OS
* Content of `deploy.php`
* Output log with enabled option for verbose output `-vvv`
## New features
All code contributions must go through a pull request and approved by a core developer before being merged.
This is to ensure proper review of all the code.
Fork the project, create a feature branch, and send a pull request.
To ensure a consistent code base, you should make sure the code follows
the [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md).
If you would like to help take a look at the [list of issues](https://github.com/deployphp/deployer/issues).
## Make a Pull Request
Add notes about your changes to [CHANGELOG.md](https://github.com/deployphp/deployer/blob/master/CHANGELOG.md).