的语气

我们不希望你完全正式的、或甚至无错的英文写作。记住:不要发誓,尊重他人。

不要在愤怒或回复与积极的基调。你生气,我们明白,但是发誓/诅咒和骂人不鼓励任何人帮助你。深吸一口气,数到10,尝试很明显解释一下你遇到的问题。

包容性的语言

以包容广泛的人群,建议使用人称代词,不建议一个特定的性别。除非有人说他们的代词,使用“他们”、“他们”,而不是“他”、“她”、“他”、“她”、“他/她”,“他/她”,等等。

尽量避免使用可能被认为是不含的措辞,不必要的性别(例如,男性或女性基础单词,),种族动机或挑出一个特定的社会团体。例如,推荐使用单词像“人”、“团队”,“每个人”,而不是“人”,“女士”,“美国佬”,等等。

给予积极的反馈

审查问题和拉请求时你可能会遇到一些建议(包括补丁),并不能反映你的想法,并不好,或者是完全错误的。

现在,当你准备你的评论,作者考虑的工作量和时间花在他们的想法和你的反应会使他们感觉如何。

你正确理解他们的意图吗?或者你在假设吗?不管你的反应,是明确的。记得网上人们并不总是理解你的意图。

避免使用术语可以被视为指个人特质(“笨”、“愚蠢”)。假设每个人都是聪明的和善意的。

即使一些是真的错了或“一个坏主意”,保持尊重,不要陷入无休止的讨论你错了或“火焰战争”。

不要使用夸张(“总是”、“从不”、“没完没了地”,“没什么”,“坏”,“可怕的”、“可怕的”)。

别:“我不喜欢你写的这段代码”——没有明确解释为什么你不喜欢如何写。

好:“我很难读这段代码,因为很多嵌套的if语句,你可以让它更可读吗?通过封装它的一些细节或者添加一些注释来解释整体的逻辑。”——你解释为什么你觉得难读的代码和给出一些改进的建议。

如果一段代码实际上是错误的,原因:

• 这段代码不符合Symfony的CS规则。ob娱乐下载请参阅[…详情)。
• ob娱乐下载Symfony 3仍然使用PHP 5和不允许使用标量类型提示。。
• 我想现在降低代码的可读性——小心,一定解释为什么你认为降低代码的可读性,甚至给一些建议吗?

有效的原因拒绝的例子:

• 我们尝试,在过去(链接到相关的公关),但我们需要恢复XXX的原因。
• 这一变化将引入太多的合并冲突当合并Symfony分支。ob娱乐下载在过去我们一直拒绝了这样的变化。
• 我分析这个变化和疼性能显著(如果你不形象,这是一个观点,所以我们可以忽略)
• 代码不匹配Symfony的CS规则(如ob娱乐下载。使用数组()而不是[])
• 我们只提供集成非常流行的项目(如积分引导但不是自己的CSS框架)
• 这将需要添加大量的代码,使大量的变化看起来不那么重要的一个特性。在未来,可能影响维护。

要求更改

从一开始就很少的东西是完美的,而代码本身是好的。它可能不是最优或符合Symfony的编码风格。ob娱乐下载

再次,理解作者在这个问题上已经花了时间和要求(小)变化可能被误解或视为人身攻击。

感谢他们的工作(到目前为止),保持积极的态度,真正帮助他们做出的贡献一个伟大的人。特别是第一次贡献者。

使用诸如“请”、“谢谢”和“能”的要求;

• “谢谢你的工作。我离开了一些建议改进使代码更易于阅读。”
• “代码包含一些编码风格的问题,你能解决这些在我们合并?谢谢你”
• “请使用4个空格代替标签”,“这就需要在前一行”;

在拉请求审查通常可以留下更多然后一个评论,你不必使用“请”。但它不会伤害。

好像不是很多,但是说“谢谢”并让别人感到更受欢迎。

使用幽默

简而言之:极端的不当行为将不会被容忍,甚至可能让你禁止;保持真实和友好。

不要嘲讽一个严肃的话题,不是属于Symfony社区。欧宝体育平台怎么样ob娱乐下载不要忽视别人的问题;我想这是不应该发生的?。

即使一个人的解释是“邀请开玩笑”,这是一个真正的问题。开玩笑关于这无助于解决问题,只会让他们觉得自己愚蠢。而不是试图发现问题是什么。

最后的话

不要难过,如果你遵循这些提示“失败”。只要你的意图是好的,你没有冒犯或侮辱任何人;你能解释你误解,你不是故意排斥或者仅仅是失败了。

但不要说,“因为”,如果你并不意味着你道歉将从其他开发人员那里失去信誉和尊重。

己所不欲做给你们。