Skip to content

Commit 7843fe6

Browse files
committed
Bootstraped the standards for "Files and Directories"
1 parent bffe163 commit 7843fe6

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

contributing/documentation/standards.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,23 @@ Configuration examples should show all supported formats using
8181
* **Validation**: YAML, Annotations, XML, PHP
8282
* **Doctrine Mapping**: Annotations, YAML, XML, PHP
8383

84+
Files and Directories
85+
~~~~~~~~~~~~~~~~~~~~~
86+
87+
* When referencing directories, always add a trailing slash to avoid confusions
88+
with regular files (e.g. *"execute the ``console`` script located at the ``app/``
89+
directory"*).
90+
* You should include a leading dot in every file extension (e.g. *"``.ini`` files
91+
are very limited compared to ``.xml`` files"*).
92+
* When you list a Symfony file/directory hierarchy, use ``your-project/`` as the
93+
top level directory. E.g.
94+
95+
your-project/
96+
├─ app/
97+
├─ src/
98+
├─ vendor/
99+
└─ ...
100+
84101
Example
85102
~~~~~~~
86103

0 commit comments

Comments
 (0)