LinuxSuRen / LinuxSuRen/open-source-best-practice
思考：开源协作中需要注意的一些表达方式
Open
Nobody has claimed this yet.
- Dominant language
- Smarty
- Stars
- 416
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
好的语言表达方式，会起到比较好的效果，大家在阅读的时候感到舒适。但，一不小心的“表达方式”、“语言句式”可能会让其他人感觉到不舒服：
推荐的
- 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
欢迎补充“好的”、“坏的”案例
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the recommended and discouraged expressions listed in issue #42. Add a concise good or bad communication example, explain why it helps or may feel uncomfortable, and confirm that it fits the project's open-source best-practice guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100