LinuxSuRen / LinuxSuRen/open-source-best-practice

检查:在README和SIG章节有一些表述的问题

Open
#65 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Smarty
Stars
416
Forks
31
PR merge metrics
No merged PRs in 30d

Description

我在阅读的过程中,遇到了以下问题,希望大家能指正。
- README
* 为什么?
1. “首先”。有了首先,却没有然后。
2. “对于首次准备尝试参与开源的人来说”。可以去掉准备或者尝试。
3. “很容易有无从着手的感觉”。缺少对做什么事有无从着手的感觉。
4. “万事开头难,希望这一份最佳实践可以帮助更多有意参与开源的人们。不管你是一名普通的研发、还是一名非技术人员,参与开源必将使得你受益匪浅”。建议调整一下语序,“不管你是一名普通的研发、还是一名非技术人员,参与开源必将使得你受益匪浅。万事开头难,希望这一份最佳实践可以帮助更多有意参与开源的人们”。这一句可以放在“为什么”这一节的最后。
5. “那这一份最佳实践和之有什么区别吗?”陈述的区别不明显。
6. “例如:存放社区治理规则的 community 仓库,存放与图片设计、logo 相关的 artwork 仓库,存放社区文档、网站的 website 仓库等等”。前面陈述为项目,这里是仓库。
* 社区治理
1. “随着社区规模的变大,社区治理的重要性会日益凸显。可能遇到的问题包括如下:”。这里的“。”可以换成“,”;“可能遇到以下问题”。
2. 后面的几条也应该是以“如何”开头。
- SIG
* 会议
1. “可以在线参加例会的成员数,毕竟是有限的,”。“参加在线例会的成员”;“有限的,”后面应该是“。”
* 退休
1. “因此,如果社区的 lead 如果希望能有源源不断的新成员加入的话, 就不能任由 SIG 的“堕落””。有两个“如果”。

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the README and SIG chapters referenced in the issue and review each listed sentence in context. Apply the proposed wording, punctuation, ordering, and consistency corrections, then reread both sections to confirm every enumerated item has been addressed.

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
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.