| layout | title |
|---|---|
default |
migrations |
These are steps you can take to help comply with the Friends Of Cake project requirements.
-
Add a
.travis.ymlfile to the root of your project and activate the GitHub webhook. -
Ensure your matrix includes the PHP versions from the boarding requirements.
-
Ensure your matrix includes the CakePHP versions from the boarding requirements.
-
Please keep
Notifications: emailset tofalseto avoid spamming (perhaps add IRC notifications?).
Review an example .travis.yml from a Friends Of Cake project.
phpcs --standard=CakePHP is used to check coding standards. More information is available on GitHub at cakephp-codesniffer.
- Add a
composer.jsonfile to the root of your project, see http://getcomposer.org/doc/04-schema.md - Set the vendor part of your name property to
friendsofcake(i.e. friendsofcake/yet-another-wonderful-name). - Ensure you use the
installer-nameextra as Composer package names don't allow uppercases, yet CakePHP expects your plugin folder name to be CamelCased.
Review an example composer.json from a Friends Of Cake project.
- Write tests. 🙇
- Add a
.coveralls.ymlfile to the root of your project. - Ensure Travis handles Coveralls (see Travis example above).
Submit the package to Packagist.
Add a LICENSE.txt file to the root of your project.
Review an example LICENSE.txt from a Friends Of Cake project.
- Must have well documented code (docblocks, @annotations etc)
- Must have well documented user guide with examples.
- GitHub Wiki pages should not be used for documentation. Use gh-pages or README.md.
Releases and Tags must use semantic versioning with descriptive changelogs. Head to GitHub for more information on creating releases.
- Must use
masterfor stable release,developfor integration branch and feature branches for the rest.