Skip to content

Commit

Permalink
Bootstraped the standards for "Files and Directories"
Browse files Browse the repository at this point in the history
  • Loading branch information
javiereguiluz committed Jun 3, 2014
1 parent bffe163 commit 7843fe6
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions contributing/documentation/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,23 @@ Configuration examples should show all supported formats using
* **Validation**: YAML, Annotations, XML, PHP
* **Doctrine Mapping**: Annotations, YAML, XML, PHP

Files and Directories
~~~~~~~~~~~~~~~~~~~~~

* When referencing directories, always add a trailing slash to avoid confusions
with regular files (e.g. *"execute the ``console`` script located at the ``app/``
directory"*).
* You should include a leading dot in every file extension (e.g. *"``.ini`` files
are very limited compared to ``.xml`` files"*).
* When you list a Symfony file/directory hierarchy, use ``your-project/`` as the
top level directory. E.g.

your-project/
├─ app/
├─ src/
├─ vendor/
└─ ...

Example
~~~~~~~

Expand Down

0 comments on commit 7843fe6

Please sign in to comment.