diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..17b6ca8ad --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,27 @@ +Contributing to bk-lesscode + +我们欢迎 report Issues 或者 pull requests。 在贡献代码之前请阅读以下指引。 + +问题管理 +我们用 Github Issues 去跟踪 public bugs 和 feature requests。 + +查找已知的 issue 优先 +请查找已存在或者相类似的 issue,从而保证不存在冗余。 + +新建 Issues +新建 issues 时请提供详细的描述、截屏或者短视频来辅助我们定位问题 + +分支管理 +Pull Requests +我们欢迎大家贡献代码来使我们的 bk-lesscode 更加强大,代码团队会监控所有的 pull request, 我们会做相应的代码检查和测试,测试通过之后我们就会接纳 PR ,但是不会立即合并到 master 分支。 + +在完成一个 pr 之前请做一下确认: + +从 master 或者 develop fork 你自己的分支。 +在修改了代码之后请修改对应的文档和注释。 +在新建的文件中请加入 license 和 copy right 申明。 +确保一致的代码风格。 +做充分的测试。 +然后,你可以提交你的代码到 develop 或者 hotfix 分支。 +代码协议 +MIT LICENSE 为 bk-lesscode 的开源协议,你贡献的代码也会受此协议保护。 diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..3b1924ff4 --- /dev/null +++ b/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,39 @@ + + + +**是`BUG反馈`还是`需求提交`(Is this a BUG REPORT or FEATURE REQUEST)?** (choose one): + + +**bk-lesscode 版本(The versions used):** + + +**发生了什么(What happened):** + + +**期望是什么(What you expected to happen):** + + +**如何复现(How to reproduce it):** + + +**相关的截图(Screenshot):** + + +**备注(Anything else we need to know):** diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..31f441167 --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ + + + +## 变更点(Changes) + +- xxxx + +## 相关issues (Which issues this PR fixes) + +- Fixes # + +## 备注(Special notes)