gochecklist, gochecklist是发布go项目的一组建议

分享于 

4分钟阅读

GitHub

  繁體 雙語
gochecklist is a set of recommendations for publishing Go projects.
  • 源代码名称:gochecklist
  • 源代码网址:http://www.github.com/matttproud/gochecklist
  • gochecklist源代码文档
  • gochecklist源代码下载
  • Git URL:
    git://www.github.com/matttproud/gochecklist.git
    Git Clone代码到本地:
    git clone http://www.github.com/matttproud/gochecklist
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/matttproud/gochecklist
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    命令行目

    本项目的目的是将发布的各种惯例和实践安排在一个地方。

    它是用一种方式写的,你可以在你走的时候检查每个子弹点。

    建议和指南的列表

    以下是按主题区域划分的建议,并简要解释。 对每一个的详细解释将在外部。

    发布和重复

    本小节用于最初发布项目或者使已经建立的项目经历重大重复的行为。 这些点之间的实际差别是一时间的布料应用,而后者则意味着保持项目的后续变化。

    最小标准

    不能满足它的中任何一种情况通常会导致一个项目丢弃,并查找替代项。

    请参阅:发布/授权。md

    请参阅:发布/编译。md

    请参阅:出版物/tests_pass。md。

    请参阅:出版物/code_correctness。md。

    项目是否满足了上游代码审查标准

    请参阅:出版物/code_review_comments。md。

    请参阅:出版物/build_instructions。md。

    请参阅:出版物/test_instructions。md。

    请参阅:出版物/documentation_entrypoint。md。

    每个 package <pkg> 包的语句名是否与包含的目录名匹配?

    请参阅:出版物/dir_pkg_match。md。

    请参阅:出版物/godoc_correctness。md。

    是否意外导出任何 private 或者内部类型? 所有类型都需要正确导出项目?

    请参阅:待办事项

    项目是否满足真正的必要或者提供有用的学习价值?

    请参阅:待办事项

    请参阅:待办事项

    好市民

    提供如下内容的项目将自己设置在包之上。

    项目是否采取肯定步骤以避免在黑客服务的 Unbecoming中记录的问题

    请参阅:待办事项

    维护人员是否有足够的耐心与 newcomers code代码审查流程或者愿意记录预期的expected?

    请参阅:待办事项

    请参阅:待办事项

    请参阅:待办事项

    项目是否记录它的稳定性保证,如果有的话?

    请参阅:出版物/api_stability_and_maturity。md。

    低技术的加分这里解决方案的解决方案。

    请参阅:待办事项

    变更提案提交到美国是很容易的? 团队是否积极跟踪?

    请参阅:待办事项

    项目是否具有测试,特别是易于使用和维护的测试?

    请参阅:待办事项

    请参阅:待办事项

    请参阅:待办事项

    它既不稀疏也不太密集? 可执行文件是否包含在 cmd 目录中?

    请参阅:待办事项

    额外信用

    这些点超越了一个好的公民。 已经建立和成熟的项目很可以能完成这些工作,但是它们确实不需要成功的项目。

    请参阅:待办事项

    是否在适当的注册表中列出项目列表

    请参阅:待办事项

    请参阅:待办事项

    请参阅:待办事项

    请参阅:待办事项

    请参阅:待办事项

    贡献是鼓励。指令是在 CONTRIBUTING.md 中的文档。

    许可证

    这个项目是 Apache许可证 2.0.


    相关文章