Skip to content

Commit

Permalink
Summaries should be at the bottom
Browse files Browse the repository at this point in the history
  • Loading branch information
markstory committed Mar 8, 2019
1 parent fb8c547 commit cae391f
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions en/intro/conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,21 @@ The basic pattern is
rules. See the documentation about :doc:`/core-libraries/inflector` for more
information.

Plugins Conventions
===================
It is useful to prefix a CakePHP plugin with "cakephp-" in the package name.
This makes the name semantically related on the framework it depends on.

Do **not** use the CakePHP namespace (cakephp) as vendor name as this is
reserved to CakePHP owned plugins. The convention is to use lowercase letters
and dashes as separator::

// Bad
cakephp/foo-bar

// Good
your-name/cakephp-foo-bar

Summarized
==========

Expand All @@ -156,20 +171,6 @@ Now that you've been introduced to CakePHP's fundamentals, you might try a run
through the :doc:`/tutorials-and-examples/cms/installation` to see how things fit
together.

Plugins Conventions
===================
It is useful to prefix a CakePHP plugin with "cakephp-" in the package name.
This makes the name semantically related on the framework it depends on.

Do **not** use the CakePHP namespace (cakephp) as vendor name as this is reserved to CakePHP owned plugins.
The convention is to use lowercase letters and dashes as separator::

// Bad
cakephp/foo-bar
// Good
your-name/cakephp-foo-bar

See `awesome list recommendations <https://github.com/FriendsOfCake/awesome-cakephp/blob/master/CONTRIBUTING.md#tips-for-creating-cakephp-plugins>`__ for details.

.. meta::
Expand Down

0 comments on commit cae391f

Please sign in to comment.