阅读(1833) (12)

发布开源项目之前的检查项

2020-09-08 14:45:11 更新

准备好开源你的项目了吗?有一份帮助检查清单。检查所有内容?你准备开始吧! 点击 “publish” 以及拍下自己的后背。

文档

  • [ ] 需要为项目指定一个开源协议

  • [ ] 项目要有基础文档 (README, CONTRIBUTING, CODE_OF_CONDUCT)

  • [ ] 易记的项目名,指出项目是做什么的,不能和已存在的项目冲突或者商标侵权

  • [ ] 最新的 issue 队列,组织和标记清除的issues

代码

  • [ ] 项目使用一致的代码风格和明确的功能/方法/可用的名字

  • [ ] 注释清晰的代码,记录意图和边缘案例

  • [ ] 在修改历史,issues 或者 pull requests 中没有敏感的信息 (例如 密码或者其他不能公开的信息)

如果你是代表个人:

  • [ ] 你已经告诉了你的法律部门,以及/或者理解了你公司(如果你是某一家公司的员工)的开源政策和 IP

如果你有一家公司或者组织:

  • [ ] 你已经告诉了你的法律部门

  • [ ] 你有一个宣布和促进项目的营销计划

  • [ ] 一些人被允许管理社区互动(回复 issues,检查和合并 pull requests)

  • [ ] 至少有两人管理访问项目