b7a728b7b3
* Fix check_remote task * Check remote head contents locally * Ensure .dep/HEAD file is available so error isn’t thrown * Document task usage Fixes #1990 * Fix Silverstripe recipe * Additionally check shared directory for assets since this directory is commonly excluded from project git repos * Ensure shared_assets returns a non-null value so the release folder can’t get accidentally deleted Fixes #1989 * Update CHANGELOG.md * Clarified contribution instructions * Update issue templates Added a bug report template
1.6 KiB
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.
Reporting bugs
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
Please check existing issues before opening a new issue, to prevent duplication. You can open a new issue here.
Contributing code
Fork the project, create a feature branch, and send a pull request.
If you would like to help take a look at the list of issues.
Code quality
To ensure a consistent code base, please make sure the code follows the PSR-1 standard.
Update the changelog
Before submitting code make sure to add notes about your changes to CHANGELOG.md.
To ensure consistent formatting and avoid test failures it's best to do this from the command line. From the project root first install composer dependencies (composer install), then run php bin/changelog.
Submit a pull request
All code contributions must go through a pull request and be approved by a core developer before being merged. This is to ensure proper review of all the code.