Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a1bd4ee

Browse filesBrowse files
authored
Minor "Review comments" tweaks
1 parent 4e24442 commit a1bd4ee
Copy full SHA for a1bd4ee

File tree

Expand file treeCollapse file tree

1 file changed

+13
-13
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+13
-13
lines changed

‎contributing/community/review-comments.rst

Copy file name to clipboardExpand all lines: contributing/community/review-comments.rst
+13-13Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -91,34 +91,34 @@ Don't use hyperbole ("always", "never", "endlessly", "nothing", "worst", "horrib
9191
**Don't:** *"I don't like how you wrote this code"* - there is no clear explanation why you
9292
don't like how it's written.
9393

94-
**Better:** *"I find it hard to read this code as there many nested if statements, can you make it more
95-
readable? By encapsulating some of it's details or maybe adding some comments to explain the overall logic."* -
94+
**Better:** *"I find it hard to read this code as there is many nested if statements, can you make it more
95+
readable? By encapsulating some of its details or maybe adding some comments to explain the overall logic."* -
9696
You explain why you find the code hard to read *and* give some suggestions for improvement.
9797

9898
If a piece of code is in fact wrong, explain why:
9999

100-
* ``This code doesn't comply with Symfony's CS rules. Please see [...] for details``.
100+
* "This code doesn't comply with Symfony's CS rules. Please see [...] for details."
101101

102-
* ``Symfony 3 still uses PHP 5 and doesn't allow the usage scalar type-hints.``.
102+
* "Symfony 3 still uses PHP 5 and doesn't allow the usage scalar type-hints."
103103

104-
* ``I think the code is less readable now`` - careful here, be sure explain why you think
104+
* "I think the code is less readable now." - careful here, be sure explain why you think
105105
the code is less readable, and maybe give some suggestions?
106106

107107
**Examples of valid reasons to reject:**
108108

109-
* We tried that in the past (link to the relevant PR) but we needed to revert it for XXX reason.
109+
* "We tried that in the past (link to the relevant PR) but we needed to revert it for XXX reason."
110110

111-
* That change would introduce too many merge conflicts when merging up Symfony branches.
112-
In the past we've always rejected changes like this.
111+
* "That change would introduce too many merge conflicts when merging up Symfony branches.
112+
In the past we've always rejected changes like this."
113113

114-
* I profiled this change and it hurts performance significantly (if you don't profile, it's an opinion, so we can ignore)
114+
* "I profiled this change and it hurts performance significantly" - if you don't profile, it's an opinion, so we can ignore
115115

116-
* Code doesn't match Symfony's CS rules (e.g. use ``[]`` instead of ``array()``)
116+
* "Code doesn't match Symfony's CS rules (e.g. use ``[]`` instead of ``array()``)"
117117

118-
* We only provide integration with very popular projects (e.g. we integrate Bootstrap but not your own CSS framework)
118+
* "We only provide integration with very popular projects (e.g. we integrate Bootstrap but not your own CSS framework)"
119119

120-
* This would require adding lots of code and making lots of changes for a feature that doesn't look so important.
121-
That could hurt maintaining in the future.
120+
* "This would require adding lots of code and making lots of changes for a feature that doesn't look so important.
121+
That could hurt maintaining in the future."
122122

123123
Asking for Changes
124124
------------------

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.