Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bootstraped the standards for "Files and Directories" #3901

Merged
merged 2 commits into from
Jun 7, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 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"*).
* 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you are better documenter so if you have been doing this for years then let's do it 👍


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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love all of these!!!

Example
~~~~~~~

Expand Down Expand Up @@ -128,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
Expand Down