Skip to content

关于PR的规范说明 #2

Open
@keepchen

Description

@keepchen

关于PR的规范说明

首先非常感谢大家为开源做出贡献,非常的感谢。

为了工程的可维护性和可持续性,我们需要对PR做出一些规范性的说明:

  • 镜像版本尽可能不要使用latesttag
镜像的版本应该指定明确的版本号,这样会让使用者更加明确,另外也可以规避镜像提供者因版本升级可能引起现有配置无效甚至错误的问题。 
  • 提供相对明确且详细的README说明文档
详细的说明文档可以帮助使用者了解相关的细则以及可能出现的问题和相关的解决办法。相信使用者也更加乐意使用。
  • PR需要压缩成一个commit
我们在提交的时候,因为一些原因可能会反复提交多次,实际上除最后一次外,其余的修改记录是完全可以被压缩合并为一个的,
这样可以使提交历史和变更记录变得更加清晰。  

提示:压缩命令使用 git rebase

最后再次感谢大家为开源社区做出的贡献,感谢你们!~

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions