From 7843fe676d576521cf7679cdb7403904cdc144df Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 3 Jun 2014 11:11:45 +0200 Subject: [PATCH 1/2] Bootstraped the standards for "Files and Directories" --- contributing/documentation/standards.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index 76003a2acfe..4e9e5717f43 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -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 ~~~~~~~ From a1078847c238b0209a4f85de154821d9d6972c4d Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 3 Jun 2014 18:33:49 +0200 Subject: [PATCH 2/2] Added some suggestions and fixed one minor formatting issue --- contributing/documentation/standards.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index 4e9e5717f43..6e702c09bcf 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -87,8 +87,8 @@ 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 referencing file extensions explicitly, you should include a leading dot + for every extension (e.g. "*XML files use the ``.xml`` extension*"). * When you list a Symfony file/directory hierarchy, use ``your-project/`` as the top level directory. E.g. @@ -145,11 +145,11 @@ Language Standards * When referencing a hypothetical person, such as "a user with a session cookie", gender-neutral pronouns (they/their/them) should be used. For example, instead of: - * he or she, use they - * him or her, use them - * his or her, use their - * his or hers, use theirs - * himself or herself, use themselves + * he or she, use they + * him or her, use them + * his or her, use their + * his or hers, use theirs + * himself or herself, use themselves .. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code .. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html