Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mangoGoForward opened this issue Feb 9, 2022 · 4 comments
Open

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

mangoGoForward opened this issue Feb 9, 2022 · 4 comments

Comments

@mangoGoForward
Copy link
Contributor

mangoGoForward commented Feb 9, 2022

我在阅读的过程中,遇到了以下问题,希望大家能指正。

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

非常感谢 @mangoGoForward 仔细阅读《开源最佳实践》,并给出了详尽的建议。欢迎每一位对开源感兴趣的朋友一起完善,我也会抽时间根据 @mangoGoForward 给出的建议来修改相应的表述问题。

@LinuxSuRen
Copy link
Owner

有个想法哈,提交 issue 的也算是贡献者,不知道是否有一些简单的办法可以把所有提过 issue 的人在 markdown 文件中列出来,也表示对大家的感谢。

@kang8
Copy link
Contributor

kang8 commented Feb 12, 2022

有个想法哈,提交 issue 的也算是贡献者,不知道是否有一些简单的办法可以把所有提过 issue 的人在 markdown 文件中列出来,也表示对大家的感谢。

通过 GitHug 提供的 API(GET /repos/{owner}/{repo}/issues)可以快速拿到所有 issues 的信息,再经过简单的筛选,就可以得到所有提过 issue 的人的信息:

# requirement curl, jq, sort, uniq
$ curl https://api.github.com/repos/LinuxSuRen/open-source-best-practice/issues\?state\=all\&per_page\=100 | jq '.[].user.login' | sort | uniq
"JohnNiang"
"LinuxSuRen"
"kang8"
"kayw-geek"
"leonharetd"
"mangoGoForward"
"robekeane"
"stevending1st"
"wjsvec"
"yuzp1996"

@LinuxSuRen
Copy link
Owner

可以考虑依据这个 API 做个 badge 服务

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants