clearPHP welcomes contributions on our Github project.
Use github to submit issues : requests, fixes, suggestions or new rules.
The main way to provide us with fixes or add-on is to follow the usual github workflow :
- Fork the repo on GitHub
- Commit changes to a branch in your fork
- Pull request with your changes
- Follow the comments until it is merged or closed.
PR is the fastest way to see a contribution accepted (or not).
Here are a list of points that you can check before submitting
- Apply the reference to the examples as much as possible
- PHP examples must have opening and closing tags. The usual practice in PHP coding is to leave out the closing tag and this is fine. clearPHP is a documentation, and the closing tag is good for reading : it helps understanding that the code is finished and complete.
<?php
// some code
?>- PHP code should compile, with PHP 5.6 versions. It should be ready for newer versions, and backward compatible if reasonable.
- Links to external resources should be language-agnostic whenever possible : for example, link to php.net/echo is good, while http://ca1.php.net/fr/function.echo.php is wrong. Let the target web site negotiate mirror and language with the reader.
- Main clearPHP is in English. Articles that are not in English should be set in the related translation file.