尊重的评论

编辑本页

尊重的评论

审查问题和拉取请求是一个开始为Symfony社区做贡献的好方法。欧宝体育平台怎么样ob娱乐下载任何人都能做到!但在你发表评论之前,退一步想一想,你要说的话真的是你想要表达的吗?

在Internet上只使用文本进行通信可能会带来很大的挑战,特别是如果您还记得Symfony社区是世界性的,并且由各种不同的人组成,他们的想法和观点都不同。欧宝体育平台怎么样ob娱乐下载

不是每个人都会说英语或者会使用键盘。有些人可能有阅读障碍或类似的情况,影响他们的写作。

更不用说有些人可能会因为以前的贡献(对其他项目)而有糟糕的体验。

在这方面,你并不孤单。本指南将帮助你写出有建设性的、尊重他人的、有帮助的评论和回复。

提示

本指南并不是说教你要“顺从”或放弃你的想法和观点,而是帮助你更好地沟通,防止可能的混乱,并保持Symfony社区对每个人都是一个欢迎的地方。欧宝体育平台怎么样ob娱乐下载你可以不同意别人的观点,但不要无礼。

重要的是要接受许多编程决策都是意见。讨论你更喜欢的折衷方案,并迅速达成解决方案。这不是对与错的问题,而是使用有效的方法。

语调

我们不要求你写得非常正式,甚至不要求你写得没有错误。记住这一点:不要骂人,要尊重他人。

不要用愤怒或咄咄逼人的语气回答。如果你很生气,我们能理解,但咒骂和骂人并不能真正鼓励任何人帮助你。深呼吸,数到10,然后试着很明显解释你遇到的问题。

包容性的语言

为了包容更广泛的人群,建议使用不表示特定性别的人称代词。除非有人说了他们的代词,否则就用“他们”,“他们”来代替“他”,“她”,“他的”,“她的”,“他/她的”,“他/她的”等等。

尽量避免使用可能被认为是排斥、不必要的性别(例如以男性或女性为基础的词语)、种族动机或针对社会中的特定群体的措辞。例如,建议使用“乡亲们”、“团队”、“每个人”等词,而不是“伙计们”、“女士们”、“美国佬”等。

给予积极的反馈

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

现在,当你准备你的评论时,考虑一下作者在他们的想法上花费了多少精力和时间,以及你的回答会给他们什么感觉。

你是否正确理解了他们的意图?或者你只是在做假设?无论你的回答是什么,都要明确。记住,人们并不总是理解你在网上的意图。

避免使用可能被视为涉及个人特征的术语(“愚蠢”,“愚蠢”)。假设每个人都是聪明和善良的。

提示

好的问题避免判断,避免假设作者的观点。

也许你可以要求澄清?建议一个替代方案?或者提供一个简单的解释为什么你不同意他们的建议。

  • 这看起来是错误的。你确定这是正确的吗?(例如:打字/语法错误)
  • 你觉得用“RequestFactory”代替RequestCreator怎么样?

即使有些事情绝对错误或“坏主意”,保持尊重,不要陷入无休止的“你错了”的讨论或“火焰战”。

不要使用夸张的词(“总是”,“从不”,“无休止”,“什么都没有”,“最糟糕的”,“可怕的”,“可怕的”)。

别:"我不喜欢你写代码的方式"-没有明确的解释为什么你不喜欢它的写作方式。

好:“我发现这段代码很难读,因为有很多嵌套的if语句,你能让它更容易读吗?”通过封装一些细节,或者添加一些注释来解释整体逻辑。”-你解释一下为什么你觉得代码很难读而且提出一些改进建议。

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

  • “这段代码不符合Symfony的CS规则。ob娱乐下载请参阅[…])以了解详情。”
  • Sob娱乐下载ymfony 3仍然使用PHP 5,并且不允许使用标量类型提示。
  • “我认为现在的代码可读性下降了。”这里要小心,一定要解释为什么你认为代码可读性较差,也许会给出一些建议?

拒绝的正当理由的例子:

  • “我们过去尝试过(相关公关的链接),但出于某种原因,我们需要恢复它。”
  • “当合并Symfony分支时,这个更改会引入太多的合并冲突。ob娱乐下载在过去,我们总是拒绝这样的改变。”
  • “我分析了这个变化,它严重损害了性能”——如果你不分析,这只是一个意见,所以我们可以忽略
  • “代码不符合Symfony的CS规则(例ob娱乐下载如使用[]而不是数组())"
  • “我们只提供与非常流行的项目的集成(例如,我们集成Bootstrap,但不集成您自己的CSS框架)”
  • “这需要为一个看起来不那么重要的功能添加大量代码并做出大量更改。这可能会影响未来的维护。”

要求改变

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

同样,要明白作者已经在这个问题上花了时间,要求(小的)修改可能会被误解或被视为人身攻击。

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

用“请”、“谢谢”和“你能”这样的词来代替提出要求;

  • “谢谢你到目前为止所做的工作。我留下了一些改进建议,以使代码更具可读性。”
  • “你的代码包含一些编码风格的问题,你能在我们合并之前解决这些问题吗?”谢谢你”
  • “请使用4个空格而不是制表符”,“这需要在上一行”;

在pull request review期间,你通常可以留下多条评论,你不必一直使用“Please”。但这也无伤大雅。

这可能看起来没什么,但说“谢谢”确实会让别人感觉更受欢迎。

防止升级

有时,当人们收到反馈时,他们可能会产生抵触情绪。在这种情况下,最好尝试以不同的方式进行讨论,不要进一步升级。

如果你想找人调解,请加入#普通发布版频道ob娱乐下载Symfony松弛有一个安全的环境,并为共同的目标而努力。

使用幽默

简而言之:极端的不当行为是不被容忍的,甚至可能会让你被封号;保持真诚和友好。

不要在严肃的话题上使用讽刺,那不属于Symfony社区。欧宝体育平台怎么样ob娱乐下载不要忽视别人的问题;我猜这是不应该发生的?

即使有人的解释是“让人开玩笑”,这对他们来说也是一个真正的问题。拿这件事开玩笑并不能帮助解决他们的问题,只会让他们更加烦恼觉得自己愚蠢.相反,试着去发现真正的问题。

最后的话

如果你“没有”遵循这些建议,也不要感到难过。只要你的意图是好的,你没有冒犯或侮辱任何人;你可以解释你误解了他,你不是有意要边缘化他,或者只是失败了。

但如果你的道歉不是真心的,不要说“只是因为”失去其他开发者的信任和尊重。

己所不欲,勿施于人。

此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。
ob娱乐下载Symfony 6.2支持通过苏禄人
ob娱乐下载Symfony 6.2支持通过Les-Tilleuls.coop