Contributing to phpSmug
The Get Going Quick Guide
- Fork the phpSmug repository on GitHub.
- If you're submitting a fix or improvement to the phpSmug code or submitting a new example, create a new branch from the
masterbranch, for example:
- If you're submitting a fix or improvement to the phpSmug website or documentation, create a new branch from the
- If you're submitting code changes, as opposed to documentation, write tests that fail without your changes and pass with them.
- Ensure all tests pass locally by running:
vendor/bin/phpunitwithin your local clone of the repository.
- Submit a pull request.
All pull requests will be reviewed and will be merged once all tests have passed.
To try and keep things looking
All contributions are automatically checked against these standards using php-cs-fixer.
By contributing code you agree to license your contribution under the MIT license.
By contributing documentation, examples, or any other non-code assets you agree to license your contribution under the CC BY 3.0 license. Attribution shall be given according to the current bylaws of this group.