Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 的开源协议,你贡献的代码也会受此协议保护。
39 changes: 39 additions & 0 deletions docs/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!--
感谢提交issue, 在提交前, 请回答下列的问题, 以便更高效地沟通.

另外, 可以先根据关键字搜索issue, 可能已经有其他用户提交过了.

如果是一个 bug反馈. 尽可能提供详细的信息, 否则我们可能无法帮助到你

如果是一个 需求提交, 请对需求进行详细描述.

Thanks for filing an issue! Before hitting the button, please answer these questions. It's helpful to search the existing GitHub issues first. It's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of

If this is a BUG REPORT, please:
- Fill in as much of the template below as you can. If you leave out
information, we can't help you as well.

If this is a FEATURE REQUEST, please:
- Describe *in detail* the feature/behavior/change you'd like to see.
-->


**是`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):**
18 changes: 18 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!--
请保证PR标题明确清晰, 易于理解
Keep PR title verbose enough

相关issue可以是 #编号 或者贴 issue链接
`Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->


## 变更点(Changes)

- xxxx

## 相关issues (Which issues this PR fixes)

- Fixes #

## 备注(Special notes)