Contributing to bk-sops

我们欢迎 Report Issues 或者 Pull requests。 在贡献代码之前请阅读以下指引。

问题管理

我们用 Github Issues 去跟踪 public bugs 和 feature requests。

优先查找已知的 Issue

请查找已存在或者相似的 Issue,避免重复。

新建 Issue

新建 Issue 时请提供详细的描述、截屏或者短视频来辅助我们定位问题。

Pull Requests

我们欢迎大家贡献代码来使我们的标准运维更加强大,代码团队会监控所有的 Pull request, 我们会做相应的代码检查和测试,测试通过之后我们就会接纳 PR ,但是不会立即合并到 master 分支。

在完成一个 PR 之前请做一下确认:

  1. master 或者 hotfix fork 你自己的分支。
  2. 在修改了代码之后请修改对应的文档和注释。
  3. 在新建的文件中请加入 license 和 copy right 申明。
  4. 确保一致的代码风格。
  5. 做充分的测试。
  6. 然后,你可以提交你的代码到 dev 或者 hotfix 分支。

代码协议

MIT LICENSE 为标准运维的开源协议,您贡献的代码也会受此协议保护。