@@ -4,24 +4,26 @@ Giving constructive criticism
4
4
:doc: `Reviewing issues and pull request </contributing/community/reviews >` is a great way to get started with
5
5
contributing to the Symfony community. Anyone can do it! But before
6
6
you give a comment, take a step back and think, is what you are about
7
- to say actually what you indent ?
7
+ to say actually what you intend ?
8
8
9
- Communicating over the internet with nothing but text can pose a
10
- big challenge, especially if you remember the Symfony community
9
+ Communicating over the Internet with nothing but text can pose a
10
+ big challenge, especially if you remember that the Symfony community
11
11
is world-wide and is composed of a wide variety of people with differing
12
- idea's and opinions.
12
+ ideas and opinions.
13
13
14
- Not everyone speaks English, is able to use a keyboard, and some might
15
- even have dyslexia. And not to mention that some might have a
16
- bad experience from previous contributions (to other projects).
14
+ Not everyone speaks English or is able to use a keyboard, some might
15
+ have Dyslexia or similar conditions that affect their writing.
17
16
18
- Your not alone in this, this guide will try help you write
17
+ Not to mention that some might have a bad experience from previous
18
+ contributions (to other projects).
19
+
20
+ You're not alone in this. This guide will try help you write
19
21
constructive, respectful and helpful reviews and replies.
20
22
21
23
.. tip ::
22
24
23
25
This guide is not about lecturing you to "conform" or give-up
24
- your ideas and opinions. But helping you to better communicate,
26
+ your ideas and opinions but helping you to better communicate,
25
27
prevent possible confusion, and keeping the Symfony community a
26
28
welcoming place for everyone. **You are free to disagree with
27
29
someone's opinions just don't be disrespectful. **
@@ -45,7 +47,7 @@ Gender pronouns
45
47
---------------
46
48
47
49
While not "formally" required it's better to use gender-neutral pronouns.
48
- Unless someone "indicated" there pronouns, use "they", "them" instead of
50
+ Unless someone "indicated" their pronouns, use "they", "them" instead of
49
51
"he", "she", "his", "hers", "his/hers", "he/she", etc.
50
52
51
53
And instead of saying "guys" it's better to use "folks", or Symfonions
@@ -55,19 +57,18 @@ Giving positive feedback
55
57
------------------------
56
58
57
59
While reviewing issues and pull request you may run into some suggestions
58
- (including patches) that don't reflect your idea's, are not good, or down
59
- right wrong.
60
+ (including patches) that don't reflect your ideas, are not good, or downright wrong.
60
61
61
- Now, instead of writing a lengthy comment why you think they are wrong.
62
- Consider the amount of work and time the author has spend on there idea.
63
- And how your response would make them feel;
62
+ Now, instead of writing a lengthy comment why you think they are wrong,
63
+ consider the amount of work and time the author has spent on their idea
64
+ and how you're response would make them feel;
64
65
65
66
* Are you making a point only because you believe they are wrong?
66
67
67
- * Did you correctly understand there intention? or are you making assumptions?
68
+ * Did you correctly understand their intention? or are you making assumptions?
68
69
69
- Maybe you can ask for clarification?, suggest an alternative? or
70
- provide a simple explanation *why * disagree with there proposal.
70
+ Maybe you can ask for clarification? suggest an alternative? or
71
+ provide a simple explanation *why * disagree with their proposal.
71
72
72
73
Even if something *is * really wrong or "a bad idea", stay respectful and
73
74
don't get into endless you-are-wrong discussions or "flame wars".
@@ -78,12 +79,12 @@ don't get into endless you-are-wrong discussions or "flame wars".
78
79
* Avoid using terms that could be seen as referring to personal traits. ("dumb",
79
80
"stupid"). Assume everyone is intelligent and well-meaning.
80
81
81
- * Be explicit. Remember people don't always understand your intentions online.
82
+ * Be explicit. Remember people don't always understand you're intentions online.
82
83
83
84
* Don't use hyperbole. ("always", "never", "endlessly", "nothing", "worst",
84
85
"horrible", "terrible").
85
86
86
- Instead of saying "This is a horrible idea" use something like
87
+ Instead off saying "This is a horrible idea" use something like
87
88
"This can introduce issues in the future. Please make sure this is safe to use."
88
89
89
90
Asking for changes
@@ -92,10 +93,10 @@ Asking for changes
92
93
Rarely something is perfect from the start, while the code itself is good.
93
94
It may not be optimal or conform the Symfony coding style.
94
95
95
- Again, understand the author already spend time on the issue and asking
96
+ Again, understand the author already spent time on the issue and asking
96
97
for (small) changes may be misinterpreted or seen as a personal attack.
97
98
98
- Be thankful for there work (so far), stay positive and really help them
99
+ Be thankful for their work (so far), stay positive and really help them
99
100
to make the contribution a great one. *Especially if they are a first
100
101
time contributor. *
101
102
@@ -125,17 +126,17 @@ OK, lets be honest. We all make jokes, some are funny and some are not.
125
126
They don't put anyone of, right? Well, who's to tell. What's funny to one
126
127
is offensive to another.
127
128
128
- In short. Keep it real. There is nothing wrong with using a meme or emoji
129
- from time to time, but don't over do it. And even then, keep it friendly.
129
+ In short, keep it real. Their is nothing wrong with using a meme or emoji
130
+ from time to time, but don't overdo it. And even then, keep it friendly.
130
131
131
132
**Don't use sarcasm for a serious topic, that's not something that belongs
132
133
to the Symfony community. ** And don't marginalize someone's problems;
133
- "Well I guess that's not suppose to happen? 😆 ".
134
+ "Well I guess that's not supposed to happen? 😆 ".
134
135
135
- Even if someone's explanation is "inviting to joke about", it's a real
136
- problem to them. Making jokes about this doesn't help with solving
137
- there problem and only makes them *feel stupid *. Instead try to discover
138
- what the problem is really about.
136
+ Even if someone's explanation is "inviting to joke about it ", it's a real
137
+ problem to them. Making jokes about this doesn't help with solving their
138
+ problem and only makes them *feel stupid *. Instead try to discover what
139
+ the problem is really about.
139
140
140
141
If emoji, animated gifs, or humor aren't you, don't force them.
141
142
@@ -150,5 +151,5 @@ simply failed.
150
151
But don't say it "just because", if your apology is not really meant
151
152
you *will * loose credibility and respect from other developers.
152
153
153
- *Don't do unto others what you don't want others to do unto you. *
154
+ *Do unto others as you would have them do unto you. *
154
155
0 commit comments