-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
||
your-project/ | ||
├─ app/ | ||
├─ src/ | ||
├─ vendor/ | ||
└─ ... | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Love all of these!!! |
||
Example | ||
~~~~~~~ | ||
|
||
|
@@ -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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 👍