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

如何参与项目的 PR 贡献? #91

Closed
fengstats opened this issue Jan 30, 2024 · 10 comments
Closed

如何参与项目的 PR 贡献? #91

fengstats opened this issue Jan 30, 2024 · 10 comments
Labels
documentation Improvements or additions to documentation

Comments

@fengstats
Copy link
Collaborator

fengstats commented Jan 30, 2024

主要是涉及到的 规范 / 流程 / 注意事项,后续会将这些内容会写到 CONTRIBUTING.md 文档中,大家可以在这里讨论或者补充建议,十分感谢 🙏

@fengstats fengstats changed the title 如何参与项目 PR 贡献? 如何参与项目的 PR 贡献? Jan 30, 2024
@fengstats fengstats pinned this issue Jan 30, 2024
@fengstats
Copy link
Collaborator Author

fengstats commented Jan 30, 2024

不再使用 issue ➕ 留言 deadline 认领的方式,原因如下

  1. 认领后任务会被某个用户所占据,让其他也想 pr 这个功能的同学无法参与进来
  2. 如果 deadline 太长可能会阻塞该任务进度
  3. 针对一个功能/问题,有多个 pr 的也可以方便对比实现

看看和自己实现的有哪里不一样,比一比到底谁的解决思路更好一些,继续 pr

@fengstats
Copy link
Collaborator Author

fengstats commented Jan 30, 2024

关于 issue 和 pr 的相关性

  1. 在提交 pr 前先创建一个 issue 用来描述问题或展开讨论
  2. pr 主要是用来解决问题的,一个 pr 最好对应一个问题的解决,不要多个问题提交到一个 pr 上
  3. 可以在 commit message 或者所提 pr 的 Conversation 下留言提供对应 issue 关联信息

比如 related to #66 ,closed #88, part of #110 等,方便其他人去查看对应的 issue

@fengstats
Copy link
Collaborator Author

fengstats commented Jan 30, 2024

关于 commit message 格式的参考文档:

@fengstats
Copy link
Collaborator Author

fengstats commented Jan 30, 2024

不再使用 issues + 留言 deadline 认领的方式占据任务,因为

  1. 如果 deadline 太长可能会阻塞该任务进度,让一些有时间并想 pr 的同学无法参与进来
  2. 针对一个功能/问题,有多个 pr 的也可以方便对比实现

看看和自己实现的有哪里不一样,比一比到底谁的解决思路更好一些,继续 pr

举例说明

A 同学解决了 issue,提交了 pr 然后 merge 了

但是这时候 B 同学其实也解决了这个 issue,代码已经写好了

那么对于 B 同学来讲,可以先看看 A 同学的解决思路是不是比自己更优秀

如果不如自己,那么嘿嘿嘿,继续提交 pr!指出自己的解决方案为什么更优 🏄‍♂️

如果自己的解决方案不如 A 同学, 那么 B 同学正好也学到了更优秀的解决思路~ 😊

这样咱就不会有以下问题的担忧

合并了 A 同学的,但是不合 B 同学的 pr 问题

以及会不会让 B 同学做了无用功?白实现了?没有用他的代码的问题

@fengstats fengstats added good first issue Good for newcomers documentation Improvements or additions to documentation and removed good first issue Good for newcomers labels Jan 30, 2024
@fengstats
Copy link
Collaborator Author

提交 PR 详细流程可以参考:如何给想贡献的仓库提交 PR?

@refanbanzhang
Copy link
Contributor

前端想参与,后端服务和数据库能出个简易的安装配置说明吗?

@fengstats
Copy link
Collaborator Author

前端想参与,后端服务和数据库能出个简易的安装配置说明吗?

@refanbanzhang 你好,关于安装配置等等启动步骤,在项目的说明文档中都有,目前后端服务和数据库都是通过 docker 启动的,根据文档中 如何开始 一步步来即可,遇到问题可以随时反馈,链接地址:如何开始?

@refanbanzhang
Copy link
Contributor

前端想参与,后端服务和数据库能出个简易的安装配置说明吗?

@refanbanzhang 你好,关于安装配置等等启动步骤,在项目的说明文档中都有,目前后端服务和数据库都是通过 docker 启动的,根据文档中 如何开始 一步步来即可,遇到问题可以随时反馈,链接地址:如何开始?

好的,谢谢!

@fengstats
Copy link
Collaborator Author

fengstats commented Mar 16, 2024

提 PR 时,统一保持的英文 title 和 commit msg,有助于维护项目的整体一致性和专业性 😊

  • 标题要简洁明了
  • 详细的补充改动的内容(特别是重构),换位思考下,你也不希望你花了时间精力写的 PR 被维护者一言不合就关掉吧?

image

  • 而提交信息应该详细的描述改动的原因、范围以及影响

1710580694368

@fengstats
Copy link
Collaborator Author

关于星荣课程数据的更改说明

英文太多一词多义,一般更改的其实没什么问题,主要是目前 Earthworm 中的课程内容是需要和星荣的视频课程对齐的,所以没什么必要修改这部分内容,不然后续比如有看视频的用户来刷课程发现对不上,这时候咋办?如果和视频不一致,此时可以附上截图这样(虽然有点难找),方便我们看一眼就能确认好,很快就能合~

除非很离谱的错误,不然我们也需要去看一眼视频课程里面的确认之后才能合,所以有时候也会比较耗时,感谢理解~

如果是一些机翻僵硬的问题,可以到这个 issue 中进行留言帮助,一人力量虽小,但团队的力量是强大的,非常感谢您!

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

No branches or pull requests

2 participants