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.

Sign up for GitHub

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

Bootstraped the standards for "Files and Directories" #3901

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7843fe6
Bootstraped the standards for "Files and Directories"
javiereguiluz Jun 3, 2014
a107884
Added some suggestions and fixed one minor formatting issue
javiereguiluz Jun 3, 2014
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
17 changes: 17 additions & 0 deletions contributing/documentation/standards.rst
View file
Open in desktop
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"*).
Copy link
Member

Choose a reason for hiding this comment

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

in every file extension -> for each file extension ?

Copy link
Member

Choose a reason for hiding this comment

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

very very very minor detail: in the docs we are used to do put the styling inside the quotations instead of outside (as you do here). So "*``.ini`` files are [...]*" instead of *"``.ini`` files are [...]"*

* 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