-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #717 from didi/master
合并主分支
- Loading branch information
Showing
223 changed files
with
7,936 additions
and
1,473 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
name: 报告Bug | ||
about: 报告KnowStreaming的相关Bug | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
- [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。 | ||
|
||
你是否希望来认领这个Bug。 | ||
|
||
「 Y / N 」 | ||
|
||
### 环境信息 | ||
|
||
* KnowStreaming version : <font size=4 color =red> xxx </font> | ||
* Operating System version : <font size=4 color =red> xxx </font> | ||
* Java version : <font size=4 color =red> xxx </font> | ||
|
||
|
||
### 重现该问题的步骤 | ||
|
||
1. xxx | ||
|
||
|
||
|
||
2. xxx | ||
|
||
|
||
3. xxx | ||
|
||
|
||
|
||
### 预期结果 | ||
|
||
<!-- 写下应该出现的预期结果?--> | ||
|
||
### 实际结果 | ||
|
||
<!-- 实际发生了什么? --> | ||
|
||
|
||
--- | ||
|
||
如果有异常,请附上异常Trace: | ||
|
||
``` | ||
Just put your stack trace here! | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: 讨论问题 | ||
url: https://github.com/didi/KnowStreaming/discussions/new | ||
about: 发起问题、讨论 等等 | ||
- name: KnowStreaming官网 | ||
url: https://knowstreaming.com/ | ||
about: KnowStreaming website |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: 优化建议 | ||
about: 相关功能优化建议 | ||
title: '' | ||
labels: Optimization Suggestions | ||
assignees: '' | ||
|
||
--- | ||
|
||
- [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。 | ||
|
||
你是否希望来认领这个优化建议。 | ||
|
||
「 Y / N 」 | ||
|
||
### 环境信息 | ||
|
||
* KnowStreaming version : <font size=4 color =red> xxx </font> | ||
* Operating System version : <font size=4 color =red> xxx </font> | ||
* Java version : <font size=4 color =red> xxx </font> | ||
|
||
### 需要优化的功能点 | ||
|
||
|
||
### 建议如何优化 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: 提议新功能/需求 | ||
about: 给KnowStreaming提一个功能需求 | ||
title: '' | ||
labels: feature | ||
assignees: '' | ||
|
||
--- | ||
|
||
- [ ] 我在 [issues](https://github.com/didi/KnowStreaming/issues) 中并未搜索到与此相关的功能需求。 | ||
- [ ] 我在 [release note](https://github.com/didi/KnowStreaming/releases) 已经发布的版本中并没有搜到相关功能. | ||
|
||
你是否希望来认领这个Feature。 | ||
|
||
「 Y / N 」 | ||
|
||
|
||
## 这里描述需求 | ||
<!--请尽可能的描述清楚您的需求 --> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
name: 提个问题 | ||
about: 问KnowStreaming相关问题 | ||
title: '' | ||
labels: question | ||
assignees: '' | ||
|
||
--- | ||
|
||
- [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。 | ||
|
||
## 在这里提出你的问题 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
请不要在没有先创建Issue的情况下创建Pull Request。 | ||
|
||
## 变更的目的是什么 | ||
|
||
XXXXX | ||
|
||
## 简短的更新日志 | ||
|
||
XX | ||
|
||
## 验证这一变化 | ||
|
||
XXXX | ||
|
||
请遵循此清单,以帮助我们快速轻松地整合您的贡献: | ||
|
||
* [ ] 确保有针对更改提交的 Github issue(通常在您开始处理之前)。诸如拼写错误之类的琐碎更改不需要 Github issue。您的Pull Request应该只解决这个问题,而不需要进行其他更改—— 一个 PR 解决一个问题。 | ||
* [ ] 格式化 Pull Request 标题,如[ISSUE #123] support Confluent Schema Registry。 Pull Request 中的每个提交都应该有一个有意义的主题行和正文。 | ||
* [ ] 编写足够详细的Pull Request描述,以了解Pull Request的作用、方式和原因。 | ||
* [ ] 编写必要的单元测试来验证您的逻辑更正。如果提交了新功能或重大更改,请记住在test 模块中添加 integration-test | ||
* [ ] 确保编译通过,集成测试通过 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
|
||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
education, socio-economic status, nationality, personal appearance, race, | ||
religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected] . All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,150 @@ | ||
# Contribution Guideline | ||
|
||
Thanks for considering to contribute this project. All issues and pull requests are highly appreciated. | ||
|
||
## Pull Requests | ||
|
||
Before sending pull request to this project, please read and follow guidelines below. | ||
# 为KnowStreaming做贡献 | ||
|
||
1. Branch: We only accept pull request on `dev` branch. | ||
2. Coding style: Follow the coding style used in LogiKM. | ||
3. Commit message: Use English and be aware of your spell. | ||
4. Test: Make sure to test your code. | ||
|
||
Add device mode, API version, related log, screenshots and other related information in your pull request if possible. | ||
欢迎👏🏻来到KnowStreaming!本文档是关于如何为KnowStreaming做出贡献的指南。 | ||
|
||
NOTE: We assume all your contribution can be licensed under the [AGPL-3.0](LICENSE). | ||
如果您发现不正确或遗漏的内容, 请留下意见/建议。 | ||
|
||
## Issues | ||
## 行为守则 | ||
请务必阅读并遵守我们的 [行为准则](./CODE_OF_CONDUCT.md). | ||
|
||
We love clearly described issues. :) | ||
|
||
Following information can help us to resolve the issue faster. | ||
|
||
* Device mode and hardware information. | ||
* API version. | ||
* Logs. | ||
* Screenshots. | ||
* Steps to reproduce the issue. | ||
## 贡献 | ||
|
||
**KnowStreaming** 欢迎任何角色的新参与者,包括 **User** 、**Contributor**、**Committer**、**PMC** 。 | ||
|
||
我们鼓励新人积极加入 **KnowStreaming** 项目,从User到Contributor、Committer ,甚至是 PMC 角色。 | ||
|
||
为了做到这一点,新人需要积极地为 **KnowStreaming** 项目做出贡献。以下介绍如何对 **KnowStreaming** 进行贡献。 | ||
|
||
|
||
### 创建/打开 Issue | ||
|
||
如果您在文档中发现拼写错误、在代码中**发现错误**或想要**新功能**或想要**提供建议**,您可以在 GitHub 上[创建一个Issue](https://github.com/didi/KnowStreaming/issues/new/choose) 进行报告。 | ||
|
||
|
||
如果您想直接贡献, 您可以选择下面标签的问题。 | ||
|
||
- [contribution welcome](https://github.com/didi/KnowStreaming/labels/contribution%20welcome) : 非常需要解决/新增 的Issues | ||
- [good first issue](https://github.com/didi/KnowStreaming/labels/good%20first%20issue): 对新人比较友好, 新人可以拿这个Issue来练练手热热身。 | ||
|
||
<font color=red ><b> 请注意,任何 PR 都必须与有效issue相关联。否则,PR 将被拒绝。</b></font> | ||
|
||
|
||
|
||
### 开始你的贡献 | ||
|
||
**分支介绍** | ||
|
||
我们将 `dev`分支作为开发分支, 说明这是一个不稳定的分支。 | ||
|
||
此外,我们的分支模型符合 [https://nvie.com/posts/a-successful-git-branching-model/](https://nvie.com/posts/a-successful-git-branching-model/). 我们强烈建议新人在创建PR之前先阅读上述文章。 | ||
|
||
|
||
|
||
**贡献流程** | ||
|
||
为方便描述,我们这里定义一下2个名词: | ||
|
||
自己Fork出来的仓库是私人仓库, 我们这里称之为 :**分叉仓库** | ||
Fork的源项目,我们称之为:**源仓库** | ||
|
||
|
||
现在,如果您准备好创建PR, 以下是贡献者的工作流程: | ||
|
||
1. Fork [KnowStreaming](https://github.com/didi/KnowStreaming) 项目到自己的仓库 | ||
|
||
2. 从源仓库的`dev`拉取并创建自己的本地分支,例如: `dev` | ||
3. 在本地分支上对代码进行修改 | ||
4. Rebase 开发分支, 并解决冲突 | ||
5. commit 并 push 您的更改到您自己的**分叉仓库** | ||
6. 创建一个 Pull Request 到**源仓库**的`dev`分支中。 | ||
7. 等待回复。如果回复的慢,请无情的催促。 | ||
|
||
|
||
更为详细的贡献流程请看:[贡献流程](./docs/contributer_guide/贡献流程.md) | ||
|
||
创建Pull Request时: | ||
|
||
1. 请遵循 PR的 [模板](./.github/PULL_REQUEST_TEMPLATE.md) | ||
2. 请确保 PR 有相应的issue。 | ||
3. 如果您的 PR 包含较大的更改,例如组件重构或新组件,请编写有关其设计和使用的详细文档(在对应的issue中)。 | ||
4. 注意单个 PR 不能太大。如果需要进行大量更改,最好将更改分成几个单独的 PR。 | ||
5. 在合并PR之前,尽量的将最终的提交信息清晰简洁, 将多次修改的提交尽可能的合并为一次提交。 | ||
6. 创建 PR 后,将为PR分配一个或多个reviewers。 | ||
|
||
|
||
<font color=red><b>如果您的 PR 包含较大的更改,例如组件重构或新组件,请编写有关其设计和使用的详细文档。</b></font> | ||
|
||
|
||
# 代码审查指南 | ||
|
||
Commiter将轮流review代码,以确保在合并前至少有一名Commiter | ||
|
||
一些原则: | ||
|
||
- 可读性——重要的代码应该有详细的文档。API 应该有 Javadoc。代码风格应与现有风格保持一致。 | ||
- 优雅:新的函数、类或组件应该设计得很好。 | ||
- 可测试性——单元测试用例应该覆盖 80% 的新代码。 | ||
- 可维护性 - 遵守我们的编码规范。 | ||
|
||
|
||
# 开发者 | ||
|
||
## 成为Contributor | ||
|
||
只要成功提交并合并PR , 则为Contributor | ||
|
||
贡献者名单请看:[贡献者名单](./docs/contributer_guide/开发者名单.md) | ||
|
||
## 尝试成为Commiter | ||
|
||
一般来说, 贡献8个重要的补丁并至少让三个不同的人来Review他们(您需要3个Commiter的支持)。 | ||
然后请人给你提名, 您需要展示您的 | ||
|
||
1. 至少8个重要的PR和项目的相关问题 | ||
2. 与团队合作的能力 | ||
3. 了解项目的代码库和编码风格 | ||
4. 编写好代码的能力 | ||
|
||
当前的Commiter可以通过在KnowStreaming中的Issue标签 `nomination`(提名)来提名您 | ||
|
||
1. 你的名字和姓氏 | ||
2. 指向您的Git个人资料的链接 | ||
3. 解释为什么你应该成为Commiter | ||
4. 详细说明提名人与您合作的3个PR以及相关问题,这些问题可以证明您的能力。 | ||
|
||
另外2个Commiter需要支持您的**提名**,如果5个工作日内没有人反对,您就是提交者,如果有人反对或者想要更多的信息,Commiter会讨论并通常达成共识(5个工作日内) 。 | ||
|
||
|
||
# 开源奖励计划 | ||
|
||
|
||
我们非常欢迎开发者们为KnowStreaming开源项目贡献一份力量,相应也将给予贡献者激励以表认可与感谢。 | ||
|
||
|
||
## 参与贡献 | ||
|
||
1. 积极参与 Issue 的讨论,如答疑解惑、提供想法或报告无法解决的错误(Issue) | ||
2. 撰写和改进项目的文档(Wiki) | ||
3. 提交补丁优化代码(Coding) | ||
|
||
|
||
## 你将获得 | ||
|
||
1. 加入KnowStreaming开源项目贡献者名单并展示 | ||
2. KnowStreaming开源贡献者证书(纸质&电子版) | ||
3. KnowStreaming贡献者精美大礼包(KnowStreamin/滴滴 周边) | ||
|
||
|
||
## 相关规则 | ||
|
||
- Contributer和Commiter都会有对应的证书和对应的礼包 | ||
- 每季度有KnowStreaming项目团队评选出杰出贡献者,颁发相应证书。 | ||
- 年末进行年度评选 | ||
|
||
贡献者名单请看:[贡献者名单](./docs/contributer_guide/开发者名单.md) |
Oops, something went wrong.