Skip to content

Commit 508402d

Browse files
ZQKCZQKC
authored
Merge pull request #717 from didi/master
合并主分支
2 parents 045f652 + eb3e573 commit 508402d

File tree

223 files changed

+7936
-1473
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

223 files changed

+7936
-1473
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: 报告Bug
3+
about: 报告KnowStreaming的相关Bug
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。
11+
12+
你是否希望来认领这个Bug。
13+
14+
「 Y / N 」
15+
16+
### 环境信息
17+
18+
* KnowStreaming version : <font size=4 color =red> xxx </font>
19+
* Operating System version : <font size=4 color =red> xxx </font>
20+
* Java version : <font size=4 color =red> xxx </font>
21+
22+
23+
### 重现该问题的步骤
24+
25+
1. xxx
26+
27+
28+
29+
2. xxx
30+
31+
32+
3. xxx
33+
34+
35+
36+
### 预期结果
37+
38+
<!-- 写下应该出现的预期结果？-->
39+
40+
### 实际结果
41+
42+
<!-- 实际发生了什么? -->
43+
44+
45+
---
46+
47+
如果有异常，请附上异常Trace:
48+
49+
```
50+
Just put your stack trace here!
51+
```

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 讨论问题
4+
url: https://github.com/didi/KnowStreaming/discussions/new
5+
about: 发起问题、讨论 等等
6+
- name: KnowStreaming官网
7+
url: https://knowstreaming.com/
8+
about: KnowStreaming website

‎.github/ISSUE_TEMPLATE/detail_optimizing.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: 优化建议
3+
about: 相关功能优化建议
4+
title: ''
5+
labels: Optimization Suggestions
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。
11+
12+
你是否希望来认领这个优化建议。
13+
14+
「 Y / N 」
15+
16+
### 环境信息
17+
18+
* KnowStreaming version : <font size=4 color =red> xxx </font>
19+
* Operating System version : <font size=4 color =red> xxx </font>
20+
* Java version : <font size=4 color =red> xxx </font>
21+
22+
### 需要优化的功能点
23+
24+
25+
### 建议如何优化
26+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: 提议新功能/需求
3+
about: 给KnowStreaming提一个功能需求
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] 我在 [issues](https://github.com/didi/KnowStreaming/issues) 中并未搜索到与此相关的功能需求。
11+
- [ ] 我在 [release note](https://github.com/didi/KnowStreaming/releases) 已经发布的版本中并没有搜到相关功能.
12+
13+
你是否希望来认领这个Feature。
14+
15+
「 Y / N 」
16+
17+
18+
## 这里描述需求
19+
<!--请尽可能的描述清楚您的需求 -->
20+

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: 提个问题
3+
about: 问KnowStreaming相关问题
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。
11+
12+
## 在这里提出你的问题

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
请不要在没有先创建Issue的情况下创建Pull Request。
2+
3+
## 变更的目的是什么
4+
5+
XXXXX
6+
7+
## 简短的更新日志
8+
9+
XX
10+
11+
## 验证这一变化
12+
13+
XXXX
14+
15+
请遵循此清单，以帮助我们快速轻松地整合您的贡献：
16+
17+
* [ ] 确保有针对更改提交的 Github issue（通常在您开始处理之前）。诸如拼写错误之类的琐碎更改不需要 Github issue。您的Pull Request应该只解决这个问题，而不需要进行其他更改—— 一个 PR 解决一个问题。
18+
* [ ] 格式化 Pull Request 标题，如[ISSUE #123] support Confluent Schema Registry。 Pull Request 中的每个提交都应该有一个有意义的主题行和正文。
19+
* [ ] 编写足够详细的Pull Request描述，以了解Pull Request的作用、方式和原因。
20+
* [ ] 编写必要的单元测试来验证您的逻辑更正。如果提交了新功能或重大更改，请记住在test 模块中添加 integration-test
21+
* [ ] 确保编译通过，集成测试通过
22+

‎CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
In the interest of fostering an open and welcoming environment, we as
7+
contributors and maintainers pledge to making participation in our project and
8+
our community a harassment-free experience for everyone, regardless of age, body
9+
size, disability, ethnicity, gender identity and expression, level of experience,
10+
education, socio-economic status, nationality, personal appearance, race,
11+
religion, or sexual identity and orientation.
12+
13+
## Our Standards
14+
15+
Examples of behavior that contributes to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual attention or
27+
advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or
42+
reject comments, commits, code, wiki edits, issues, and other contributions
43+
that are not aligned to this Code of Conduct, or to ban temporarily or
44+
permanently any contributor for other behaviors that they deem inappropriate,
45+
threatening, offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported by contacting the project team at [email protected] . All
60+
complaints will be reviewed and investigated and will result in a response that
61+
is deemed necessary and appropriate to the circumstances. The project team is
62+
obligated to maintain confidentiality with regard to the reporter of an incident.
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
73+
74+
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md‎

Lines changed: 140 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,150 @@
1-
# Contribution Guideline
21

3-
Thanks for considering to contribute this project. All issues and pull requests are highly appreciated.
42

5-
## Pull Requests
63

7-
Before sending pull request to this project, please read and follow guidelines below.
4+
# 为KnowStreaming做贡献
85

9-
1. Branch: We only accept pull request on `dev` branch.
10-
2. Coding style: Follow the coding style used in LogiKM.
11-
3. Commit message: Use English and be aware of your spell.
12-
4. Test: Make sure to test your code.
136

14-
Add device mode, API version, related log, screenshots and other related information in your pull request if possible.
7+
欢迎👏🏻来到KnowStreaming！本文档是关于如何为KnowStreaming做出贡献的指南。
158

16-
NOTE: We assume all your contribution can be licensed under the [AGPL-3.0](LICENSE).
9+
如果您发现不正确或遗漏的内容, 请留下意见/建议。
1710

18-
## Issues
11+
## 行为守则
12+
请务必阅读并遵守我们的 [行为准则](./CODE_OF_CONDUCT.md).
1913

20-
We love clearly described issues. :)
2114

22-
Following information can help us to resolve the issue faster.
2315

24-
* Device mode and hardware information.
25-
* API version.
26-
* Logs.
27-
* Screenshots.
28-
* Steps to reproduce the issue.
16+
## 贡献
17+
18+
**KnowStreaming** 欢迎任何角色的新参与者，包括 **User** 、**Contributor**、**Committer**、**PMC** 。
19+
20+
我们鼓励新人积极加入 **KnowStreaming** 项目，从User到Contributor、Committer ，甚至是 PMC 角色。
21+
22+
为了做到这一点，新人需要积极地为 **KnowStreaming** 项目做出贡献。以下介绍如何对 **KnowStreaming** 进行贡献。
23+
24+
25+
### 创建/打开 Issue
26+
27+
如果您在文档中发现拼写错误、在代码中**发现错误**或想要**新功能**或想要**提供建议**，您可以在 GitHub 上[创建一个Issue](https://github.com/didi/KnowStreaming/issues/new/choose) 进行报告。
28+
29+
30+
如果您想直接贡献, 您可以选择下面标签的问题。
31+
32+
- [contribution welcome](https://github.com/didi/KnowStreaming/labels/contribution%20welcome) : 非常需要解决/新增 的Issues
33+
- [good first issue](https://github.com/didi/KnowStreaming/labels/good%20first%20issue): 对新人比较友好, 新人可以拿这个Issue来练练手热热身。
34+
35+
<font color=red ><b> 请注意，任何 PR 都必须与有效issue相关联。否则，PR 将被拒绝。</b></font>
36+
37+
38+
39+
### 开始你的贡献
40+
41+
**分支介绍**
42+
43+
我们将 `dev`分支作为开发分支, 说明这是一个不稳定的分支。
44+
45+
此外,我们的分支模型符合 [https://nvie.com/posts/a-successful-git-branching-model/](https://nvie.com/posts/a-successful-git-branching-model/). 我们强烈建议新人在创建PR之前先阅读上述文章。
46+
47+
48+
49+
**贡献流程**
50+
51+
为方便描述,我们这里定义一下2个名词：
52+
53+
自己Fork出来的仓库是私人仓库, 我们这里称之为 ：**分叉仓库**
54+
Fork的源项目,我们称之为：**源仓库**
55+
56+
57+
现在，如果您准备好创建PR, 以下是贡献者的工作流程:
58+
59+
1. Fork [KnowStreaming](https://github.com/didi/KnowStreaming) 项目到自己的仓库
60+
61+
2. 从源仓库的`dev`拉取并创建自己的本地分支,例如: `dev`
62+
3. 在本地分支上对代码进行修改
63+
4. Rebase 开发分支, 并解决冲突
64+
5. commit 并 push 您的更改到您自己的**分叉仓库**
65+
6. 创建一个 Pull Request 到**源仓库**的`dev`分支中。
66+
7. 等待回复。如果回复的慢，请无情的催促。
67+
68+
69+
更为详细的贡献流程请看：[贡献流程](./docs/contributer_guide/贡献流程.md)
70+
71+
创建Pull Request时：
72+
73+
1. 请遵循 PR的 [模板](./.github/PULL_REQUEST_TEMPLATE.md)
74+
2. 请确保 PR 有相应的issue。
75+
3. 如果您的 PR 包含较大的更改，例如组件重构或新组件，请编写有关其设计和使用的详细文档(在对应的issue中)。
76+
4. 注意单个 PR 不能太大。如果需要进行大量更改，最好将更改分成几个单独的 PR。
77+
5. 在合并PR之前，尽量的将最终的提交信息清晰简洁, 将多次修改的提交尽可能的合并为一次提交。
78+
6. 创建 PR 后，将为PR分配一个或多个reviewers。
79+
80+
81+
<font color=red><b>如果您的 PR 包含较大的更改，例如组件重构或新组件，请编写有关其设计和使用的详细文档。</b></font>
82+
83+
84+
# 代码审查指南
85+
86+
Commiter将轮流review代码，以确保在合并前至少有一名Commiter
87+
88+
一些原则：
89+
90+
- 可读性——重要的代码应该有详细的文档。API 应该有 Javadoc。代码风格应与现有风格保持一致。
91+
- 优雅：新的函数、类或组件应该设计得很好。
92+
- 可测试性——单元测试用例应该覆盖 80% 的新代码。
93+
- 可维护性 - 遵守我们的编码规范。
94+
95+
96+
# 开发者
97+
98+
## 成为Contributor
99+
100+
只要成功提交并合并PR , 则为Contributor
101+
102+
贡献者名单请看：[贡献者名单](./docs/contributer_guide/开发者名单.md)
103+
104+
## 尝试成为Commiter
105+
106+
一般来说, 贡献8个重要的补丁并至少让三个不同的人来Review他们(您需要3个Commiter的支持)。
107+
然后请人给你提名, 您需要展示您的
108+
109+
1. 至少8个重要的PR和项目的相关问题
110+
2. 与团队合作的能力
111+
3. 了解项目的代码库和编码风格
112+
4. 编写好代码的能力
113+
114+
当前的Commiter可以通过在KnowStreaming中的Issue标签 `nomination`(提名)来提名您
115+
116+
1. 你的名字和姓氏
117+
2. 指向您的Git个人资料的链接
118+
3. 解释为什么你应该成为Commiter
119+
4. 详细说明提名人与您合作的3个PR以及相关问题,这些问题可以证明您的能力。
120+
121+
另外2个Commiter需要支持您的**提名**，如果5个工作日内没有人反对，您就是提交者,如果有人反对或者想要更多的信息，Commiter会讨论并通常达成共识(5个工作日内) 。
122+
123+
124+
# 开源奖励计划
125+
126+
127+
我们非常欢迎开发者们为KnowStreaming开源项目贡献一份力量，相应也将给予贡献者激励以表认可与感谢。
128+
129+
130+
## 参与贡献
131+
132+
1. 积极参与 Issue 的讨论，如答疑解惑、提供想法或报告无法解决的错误（Issue）
133+
2. 撰写和改进项目的文档（Wiki）
134+
3. 提交补丁优化代码（Coding）
135+
136+
137+
## 你将获得
138+
139+
1. 加入KnowStreaming开源项目贡献者名单并展示
140+
2. KnowStreaming开源贡献者证书(纸质&电子版)
141+
3. KnowStreaming贡献者精美大礼包(KnowStreamin/滴滴 周边)
142+
143+
144+
## 相关规则
145+
146+
- Contributer和Commiter都会有对应的证书和对应的礼包
147+
- 每季度有KnowStreaming项目团队评选出杰出贡献者,颁发相应证书。
148+
- 年末进行年度评选
149+
150+
贡献者名单请看：[贡献者名单](./docs/contributer_guide/开发者名单.md)

0 commit comments

Comments
 (0)