HelloGitHub-Team / wiki

HelloGitHub-Team 协作开发须知(必读)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HelloGitHub-Team wiki

接不完的需求?堆砌没有灵魂的代码?做的功能没人用?来,加入 HG 修改、增加你想要的功能,我们不需要产品经理,最后让你的代码跑在 HelloGitHub.com 让更多人使用和看到。

一、项目介绍

本项目是 HelloGitHub-Team 开源组织的须知文档,想加入、刚加入我们的小伙伴请一定要认真阅读本项目中涵盖的文档。

Tips: 有任何问题直接提 PR 修改。

二、须知部分

开源项目协作开发是一件自由且松散的事情,但是项目工程又是一件严谨的事情。所以需要一些规范来让事情有条不紊的进展和推进,所以下面列举了一些一起协作开发之前需要知道的事情和遵守的规范。

  1. 内容编写规范
  2. 协作开发须知
  3. 接口文档

三、我们的项目

以下项目都是为了方便更好的发掘、推荐 GitHub 上优秀的开源项目。

  • 官网
  • HelloGitHub:鼻祖项目,发布最新月刊、历史月刊集合的项目。
  • wiki:团队成员必读的 wiki 文档包含:书写规范、开发规范、接口文档。
  • taichi:太极,数据可视化前端,逐步替代官网的前端项目。
  • hellogithub.com:后端项目,包含网站的服务端、管理后台、Issues 机器人、三方接口,目前正在基于 fastapi 重构中(完成后开源)。

四、加入我们

目前我们正处于前后端分离、重构的阵痛期,每个人的时间都很宝贵,请阅读完上面的信息后再联系我。

不欢迎需要督促、伸手党,确定想要业余时间和 HG 一起做让你骄傲、有意义的事情后再联系我。

任何人都可以在 HG-Team 中创建有价值、有趣的项目,你将会成为这个项目的负责人。作为负责人请让项目持续的更新下去,越来越有价值。我不在乎起点,更看重的是天花板。HG 会作为“开源项目孵化器”,让你的项目被更多人所熟知和喜欢~

优秀的项目应该包含:

  1. 详细的 README 文件
    • 言简意赅说明项目的用途和亮点
    • 详细的安装、运行步骤、运行效果图
    • 包含文档、技术栈和架构图
    • 能用图、少写字
  2. 良好的协作规范、代码风格检测和注释
  3. 完整的依赖三方库或项目明细(或者注明用的包管理工具)
  4. 尽可能高的测试覆盖率
  5. 简单的部署方式和自动的 CI/CD
  6. 开源协议

最后:请思考一个问题:你坚持最久的一件事情是什么,坚持了多长时间?

微信:xueweihan(备注:前端 or 后端),然后请开始你的故事。

五、声明

知识共享许可协议
本作品采用 署名-非商业性使用-禁止演绎 4.0 国际 进行许可。

ezoic increase your site revenue

About

HelloGitHub-Team 协作开发须知(必读)

License:Other