open-source-best-practice icon indicating copy to clipboard operation
open-source-best-practice copied to clipboard

思考:开源协作中需要注意的一些表达方式

Open LinuxSuRen opened this issue 3 years ago • 2 comments

好的语言表达方式,会起到比较好的效果,大家在阅读的时候感到舒适。但,一不小心的“表达方式”、“语言句式”可能会让其他人感觉到不舒服:

推荐的

  • Investigating it, sorry for inconvenience

避免的

  • 麻烦添加一个 xxx 功能、修复一个 issue

  • 所以,请认真看一下文档

    • 听起来可能有“责备嫌疑”
  • 我们很需要 xxx,这个对我们很重要,可以 xxx 吗

    • 伸手党来要东西,拿来主义
  • I want something

  • Please fix xxx

    • [Suggestion] I'm wondering if you could see why xx is wrong
  • Why don't do something like xxx

    • [Suggestion] I'm thinking if we can try another solution xx

欢迎补充“好的”、“坏的”案例

LinuxSuRen avatar Dec 24 '21 07:12 LinuxSuRen

当你是第一次贡献代码时,大胆的说出你的背景,这没有什么丢脸的,反而会让其他人有效的帮助你。

For example:

This is my first PR here so sorry if there is not enough examples, let me know if I should add more.

From https://github.com/rstacruz/cheatsheets/pull/1554#issue-721634955

kang8 avatar Apr 09 '22 02:04 kang8

发现一个非常有趣的功能,它可以自动检测文案可能体现出来的语气、亦或是给读着的感觉。来看截图了 image

LinuxSuRen avatar May 06 '22 05:05 LinuxSuRen