Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 23b51c8

Browse filesBrowse files
committed
feature #3901 Bootstraped the standards for "Files and Directories" (javiereguiluz)
This PR was merged into the 2.3 branch. Discussion ---------- Bootstraped the standards for "Files and Directories" | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.3+ | Fixed tickets | - This is just a draft. I really need your comments and suggestions to decide the best standards for this. Commits ------- a107884 Added some suggestions and fixed one minor formatting issue 7843fe6 Bootstraped the standards for "Files and Directories"
2 parents 349cbeb + a107884 commit 23b51c8
Copy full SHA for 23b51c8

File tree

Expand file treeCollapse file tree

1 file changed

+22
-5
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+22
-5
lines changed

‎contributing/documentation/standards.rst

Copy file name to clipboardExpand all lines: contributing/documentation/standards.rst
+22-5Lines changed: 22 additions & 5 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+
* When referencing file extensions explicitly, you should include a leading dot
91+
for every extension (e.g. "*XML files use the ``.xml`` extension*").
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

@@ -128,11 +145,11 @@ Language Standards
128145
* When referencing a hypothetical person, such as "a user with a session cookie", gender-neutral
129146
pronouns (they/their/them) should be used. For example, instead of:
130147

131-
* he or she, use they
132-
* him or her, use them
133-
* his or her, use their
134-
* his or hers, use theirs
135-
* himself or herself, use themselves
148+
* he or she, use they
149+
* him or her, use them
150+
* his or her, use their
151+
* his or hers, use theirs
152+
* himself or herself, use themselves
136153

137154
.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code
138155
.. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.