Skip to content

Commit 3bc2b78

Browse files
wouterjweaverryan
authored andcommitted
Added some standards
1 parent 25a0f40 commit 3bc2b78

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

contributing/documentation/overview.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ look and feel familiar, you should follow these rules:
8888
as well as the `Twig Coding Standards`_;
8989
* Each line should break approximately after the first word that crosses the
9090
72nd character (so most lines end up being 72-78 lines);
91+
* To avoid horizontal scrolling on code blocks, we prefer to break a line
92+
correctly if it crosses the 85th character;
9193
* When you fold one or more lines of code, place ``...`` in a comment at the point
9294
of the fold. These comments are: ``// ...`` (php), ``# ...`` (yaml/bash), ``{# ... #}``
9395
(twig), ``<!-- ... -->`` (xml/html), ``; ...`` (ini), ``...`` (text);
@@ -101,7 +103,8 @@ look and feel familiar, you should follow these rules:
101103
unless the next line is also a comment;
102104
* You should put a ``$`` in front of every bash line;
103105
* The ``::`` shorthand is preferred over ``.. code-block:: php`` to begin a PHP
104-
code block.
106+
code block;
107+
* You should use a form of *you* instead of *we*.
105108

106109
An example::
107110

0 commit comments

Comments
 (0)