forked from TencentBlueKing/bk-job
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b68becb
Showing
3,287 changed files
with
366,556 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
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,25 @@ | ||
HELP.md | ||
.vscode | ||
.gradle | ||
build/ | ||
!gradle/wrapper/gradle-wrapper.jar | ||
!**/src/main/** | ||
!**/src/test/** | ||
### STS ### | ||
.apt_generated | ||
.classpath | ||
.factorypath | ||
.project | ||
.settings | ||
.springBeans | ||
.sts4-cache | ||
### IntelliJ IDEA ### | ||
.idea | ||
*.iws | ||
*.iml | ||
*.ipr | ||
out/ | ||
### application ### | ||
**/*.log | ||
support-files/dependJarLists/ | ||
**/*.DS_Store |
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,99 @@ | ||
# BK-JOB Code of Conduct | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to make 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, 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. | ||
* Conduct which could reasonably be considered inappropriate for the forum in | ||
which it occurs. | ||
|
||
All BK-JOB forums and spaces are meant for professional interactions, and any behavior which could reasonably be | ||
considered inappropriate in a professional setting is unacceptable. | ||
|
||
|
||
## 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 | ||
|
||
The Code of Conduct also applies within project spaces and in public spaces whenever an individual is representing | ||
BK-JOB 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 or de facto representative at | ||
an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Conflict Resolution | ||
|
||
Conflicts in an open source project can take many forms, from someone having a bad day and using harsh and hurtful | ||
language in the issue queue, to more serious instances such as sexist/racist statements or threats of violence, | ||
and everything in between. | ||
|
||
If the behavior is threatening or harassing, or for other reasons requires immediate escalation, please see below. | ||
|
||
However, for the vast majority of issues, we aim to empower individuals to first resolve conflicts themselves, asking | ||
for help when needed, and only after that fails to escalate further. This approach gives people more control over | ||
the outcome of their dispute. | ||
|
||
If you are experiencing or witnessing conflict, we ask you to use the following escalation strategy to address | ||
the conflict: | ||
|
||
1. Address the perceived conflict directly with those involved, preferably in a | ||
real-time medium. | ||
2. If this fails, get a third party (e.g. a mutual friend, and/or someone with | ||
background on the issue, but not involved in the conflict) to intercede. | ||
3. If you are still unable to resolve the conflict, and you believe it rises to | ||
harassment or another code of conduct violation, report it. | ||
|
||
## Reporting Violations | ||
|
||
Violations of the Code of Conduct can be reported to BK-JOB’s Project Stewards, Irwin sun (irwinsun@tencent.com) | ||
and Nek zhang (nekzhang@tencent.com). The Project Steward will determine whether the Code of Conduct was violated, | ||
and will issue an appropriate sanction, possibly including a written warning or expulsion from the project, | ||
project sponsored spaces, or project forums. We ask that you make a good-faith effort to resolve your conflict | ||
via the conflict resolution policy before submitting a report. | ||
|
||
Violations of the Code of Conduct can occur in any setting, even those unrelated to the project. We will only consider | ||
complaints about conduct that has occurred within one year of the report. | ||
|
||
|
||
## Enforcement | ||
|
||
If the Project Stewards receive a report alleging a violation of the Code of Conduct, the Project Stewards will notify | ||
the accused of the report, and provide them an opportunity to discuss the report before a sanction is issued. | ||
The Project Stewards will do their utmost to keep the reporter anonymous. If the act is ongoing | ||
(such as someone engaging in harassment), or involves a threat to anyone's safety (e.g. threats of violence), | ||
the Project Stewards may issue sanctions without notice. | ||
|
||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at | ||
https://contributor-covenant.org/version/1/4, and includes some aspects of the Geek Feminism Code of Conduct and the | ||
Drupal Code of Conduct. |
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,50 @@ | ||
# 参与者公约 | ||
## 我们的承诺 | ||
为建设开放友好的环境,我们贡献者和维护者承诺:不论年龄、体型、身体健全与否、民族、性征、性别认同与表征、经验水平、教育程度、社会地位、 | ||
国籍、相貌、种族、信仰、性取向,我们项目和社区的参与者皆免于骚扰。 | ||
|
||
## 我们的准则 | ||
|
||
有助于创造积极环境的行为包括但不限于: | ||
|
||
- 措辞友好且包容 | ||
- 尊重不同的观点和经验 | ||
- 耐心接受有益批评 | ||
- 关注对社区最有利的事情 | ||
- 与社区其他成员友善相处 | ||
|
||
参与者不应采取的行为包括但不限于: | ||
|
||
- 发布与性有关的言论或图像、不受欢迎地献殷勤 | ||
- 捣乱/煽动/造谣行为、侮辱/贬损的评论、人身及政治攻击 | ||
- 公开或私下骚扰 | ||
- 未经明确授权便发布他人的资料,如住址、电子邮箱等 | ||
- 其他有理由认定为违反职业操守的不当行为 | ||
|
||
## 我们的义务 | ||
|
||
项目维护者有义务诠释何谓“妥当行为”,并妥善公正地纠正已发生的不当行为。 | ||
|
||
项目维护者有权利和义务去删除、编辑、拒绝违背本行为标准的评论(comments)、提交(commits)、代码、wiki 编辑、问题(issues)等贡献; | ||
项目维护者可暂时或永久地封禁任何他们认为行为不当、威胁、冒犯、有害的参与者。 | ||
|
||
## 适用范围 | ||
|
||
本行为标准适用于本项目。当有人代表本项目或本社区时,本标准亦适用于此人所处的公共平台。 | ||
|
||
代表本项目或本社区的情形包括但不限于:使用项目的官方电子邮件、通过官方媒体账号发布消息、作为指定代表参与在线或线下活动等。 | ||
|
||
代表本项目的行为可由项目维护者进一步定义及解释。 | ||
|
||
## 贯彻落实 | ||
|
||
违反行为准则的行为可以报告给 BK-JOB的 irwinsun(irwinsun@tencent.com) 或者 nekzhang(nekzhang@tencent.com),向项目团队举报滥用、 | ||
骚扰及不当行为。 | ||
|
||
维护团队将审议并调查全部投诉,妥善地予以必要的回应。项目团队有义务保密举报者信息。具体执行方针或将另行发布。 | ||
|
||
未切实遵守或执行本行为标准的项目维护人员,经项目负责人或其他成员决议,可能被暂时或永久地剥夺参与本项目的资格。 | ||
|
||
## 来源 | ||
|
||
本行为标准改编自参与者公约,版本 1.4 可在此查阅:https://www.contributor-covenant.org/zh-cn/version/1/4/code-of-conduct.html |
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,90 @@ | ||
# Contributing to BK-JOB | ||
|
||
The BlueKing team upholds an open attitude and welcomes like-minded developers to contribute to the project. Before you start, please read the following instructions carefully. | ||
|
||
## Code License | ||
|
||
[MIT LICENSE](LICENSE.txt) is the open source license of BK-JOB. Code contributed by anyone is protected by this license. Please make sure that you can accept the license before contributing your code. | ||
|
||
## Design Document | ||
|
||
Any functionality and feature should have its corresponding design document. Design documents need to be archived in the **docs/features** directory for the team to review and for subsequent developers to learn about the details of the features. | ||
|
||
## Contribute Functionality and Feature | ||
|
||
If you want to contribute functionalities and features to BK-JOB project, please refer to the following steps: | ||
|
||
* Contact the BlueKing team for relevant functional requirement. | ||
* Once the team approves of the functionality, an issue is created to track the feature. The issue should at least contain the problem that the feature needs to address, use cases, relevant design, implementation details and problems that may arise. | ||
* Submit detailed design document to the BlueKing team. | ||
* The BlueKing team confirms requirement scheduling, the time to merge the functionality and the feature as well as the version. | ||
* Complete coding, unit testing, use case testing and user documentation. Ensure consistent code style. | ||
* Submit Pull Request/Merge Request which contains the documentation and the code. | ||
* Functionality/Feature review. Merge after it passes. | ||
|
||
> Note: To ensure code quality, for big functionalities and features, the BlueKing tends to submit multiple PRs/MRs progressively, so that relevant developers can review the details of the changes. It may take more time to review a one-off and large-scale commit. | ||
## How to Get Started | ||
|
||
If you want to contribute your code, it is recommended to refer to existing documentation about features and development environment setup. | ||
|
||
## GIT Commit Specifications | ||
|
||
Since different projects of different teams have different code commit comments, in order to standardize the commit message of different teams in the open source environment, different marks are used to differentiate committed changes. | ||
|
||
``` | ||
git commit -m 'mark: comment of the commit issue #123' | ||
``` | ||
|
||
For example: | ||
|
||
```shell | ||
git commit -m 'fix: the bug xxx #123' | ||
``` | ||
|
||
### Mark Description | ||
|
||
| Mark | Description | | ||
| -------- | -------------------------------------- | | ||
| feature/feat | Develop a new feature | | ||
| bug/fix/bugfix | Fix a bug | | ||
| refactor/perf | Refactor the code/Optimize configurations & parameters/Optimize the logic and the functionality | | ||
| test | Add unit testing cases | | ||
| docs | Add documents | | ||
| info | Add comment information | | ||
| format | On the premise of not modifying business logic, only format the code | | ||
| merge | Only merge and synchronize branches | | ||
| depend | Add, delete or modify the dependencies of the project | | ||
| chore | Relevant code like build scripts and tasks | | ||
| del | Destructive actions like deleting functionalities and APIs that are still in use | | ||
|
||
## Pull Request/Merge Request | ||
|
||
If you are already dealing with an existing issue and have a reasonable solution, you are recommended to reply to the issue, so that the BlueKing team or other developers and users know that you are interested in the issue and have made positive progress, which prevents repetition and avoids waste of manpower. The BlueKing team upholds an open attitude and is willing to discussion solutions with you. We look forward to having you submit PR/MR. | ||
|
||
Steps to Commit a Fix | ||
|
||
* Fork the branch affected by the issue. | ||
* Create your own branch for fixing. | ||
* Fix the issue. | ||
* Add new testing cases. If you try to fix a bug, make sure that the code cannot pass the testing cases when it is not fixed. The testing cases should cover as many scenarios as possible. | ||
* Update the documentation (if necessary). | ||
* Compile successfully and pass unit testing. | ||
* Review. Merge after it passes. | ||
|
||
For fixing issues, the BlueKing team hopes that one PR/MR can cover all the relevant content, including but not limited to the code, the documentation and the user guide. | ||
|
||
Please refer to [BK-JOB Review Process](./docs/specification/review.en.md) for relevant review process. | ||
|
||
## Issues | ||
|
||
The BlueKing team uses [issues](https://github.com/Tencent/bk-job/issues) to track bugs, feature, etc. | ||
|
||
When submitting a relevant bug, please search for existing or similar issues to ensure that there is no redundancy. | ||
|
||
If you confirm that this is a new bug, please include the following information when submitting. | ||
|
||
* Information about the operating system you use. | ||
* Information about the current version you use, such as version, commitid. | ||
* Log outputs of relevant modules when the problem occurs. | ||
* Exact steps to reproduce the bug. For example, submitting relevant reproduction scripts/tools is more useful than long description. |
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,92 @@ | ||
# Contributing to BK-JOB | ||
|
||
蓝鲸团队秉持开放的态度,欢迎志同道合的开发者一起贡献项目。在开始之前,请认真阅读以下指引。 | ||
|
||
## 代码协议 | ||
|
||
[MIT LICENSE](LICENSE.txt) 为 BK-JOB 的开源协议,任何人贡献的代码也会受此协议保护,贡献代码前也请明确是否可以接受该协议。 | ||
|
||
## 设计文档 | ||
|
||
任何功能和特性都应该要有相应的设计文档。设计文档需要归档到**docs/fetures**目录中,方便团队进行审阅,也方便后续加入的开发者了解特性设计 | ||
详情。 | ||
|
||
## 贡献功能与特性 | ||
|
||
如果想对BK-JOB项目贡献功能与特性,请参考以下步骤: | ||
|
||
* 联系蓝鲸团队反馈相关的功能需求; | ||
* 一旦团队认同该功能,则创建需要issue追溯该特性。 issue应该至少包含特性需要解决的问题、用例、相关设计、实现细节以及可能遇到的问题 | ||
* 提交详细的设计文档给蓝鲸团队 | ||
* 蓝鲸团队确认需求排期,确认功能与特性合并时间与版本 | ||
* 完成编码,单元测试,测试用例,以及特性使用文档,确认一致的代码风格 | ||
* 提交Pull Request/Merge Request,包含文档与代码 | ||
* 功能/特性review,通过后合并 | ||
|
||
> 注意:为了保证代码质量,对于大的特性与功能,蓝鲸团队更倾向渐进式,积木式的多次PRs/MRs提交,如此方便相关开发者review其中变化的细节。一次性、大规模的提交可能会花费更多的时间进行review | ||
## 如何开始 | ||
|
||
想要贡献代码,建议请先参照已有的特性文档和开发环境构建文档。 | ||
|
||
## GIT提交规范 | ||
|
||
因不同团队不同的项目管理下会有不同的代码提交注释,规范化开源下对不同团队提交信息,做了不同的提交标记以规范化区分提交内容: | ||
|
||
``` | ||
git commit -m '标记: 提交的概要注释 issue #123' | ||
``` | ||
|
||
示例: | ||
|
||
```shell | ||
git commit -m 'fix: xxx问题 #123' | ||
``` | ||
|
||
### 标记说明: | ||
|
||
| 标记 | 说明 | | ||
| -------- | -------------------------------------- | | ||
| feature/feat | 新功能开发 | | ||
| bug/fix/bugfix | bug修复 | | ||
| refactor/perf | 重构代码/优化配置&参数/优化逻辑及功能 | | ||
| test | 添加单元测试用例相关 | | ||
| docs | 添加文档 | | ||
| info | 添加注释类信息 | | ||
| format | 不修改业务逻辑下,仅做代码规范的格式化 | | ||
| merge | 仅做分支合并同步 | | ||
| depend | 对工程的依赖进行增删改 | | ||
| chore | 构建脚本、任务等相关代码 | | ||
| del | 删除可能仍然有人用到的功能、API等破坏性动作 | | ||
|
||
|
||
## Pull Request/Merge Request | ||
|
||
如果你已经在处理现有的issue,对此已经有合理的解决方案,建议你在当前issue上进行回复,让蓝鲸团队或者其他开发者、使用者了解到你对该问题有兴趣,并取得了积极的进展,防止重复开发建设,避免人力浪费。蓝鲸团队抱着开放的态度,非常乐意与大家磋商解决方案,期待大家提交PR/MR。 | ||
|
||
提交建议修复的步骤: | ||
|
||
* fork受到该issue影响的分支 | ||
* 创建你自己的修复分支 | ||
* 修复问题 | ||
* 新增测试用例,如果是bug fix,确保在没有修复代码的情况下,测试用例应该无法通过;测试用例请尽可能覆盖各种情况 | ||
* 更新文档(如需要) | ||
* 编译成功,并通过单元测试 | ||
* review,通过后合并 | ||
|
||
对于issue的修复,蓝鲸团队希望一个PR/MR能涵盖所有相关的内容,包括但不限于代码,修复文档与使用说明。 | ||
|
||
相关的review流程请参照:[BK-JOB review相关流程](./docs/specification/review.md) | ||
|
||
## Issues | ||
|
||
蓝鲸团队使用[issues](https://github.com/Tencent/bk-job/issues)进行bugs追踪、特性追踪等。 | ||
|
||
当提交相关的bug时,请查找已存在或者相类似的issue,从而保证不存在冗余。 | ||
|
||
如果确认该bug是一个新的bug,提交时请包含以下的信息: | ||
|
||
* 你所使用的操作系统信息 | ||
* 当前你使用的版本信息,例如version,commitid | ||
* 出现问题时,相关模块的日志输出 | ||
* 重现该问题的准确步骤,例如提交相关重现脚本/工具会比大量描述更有用一些 |
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,21 @@ | ||
Tencent is pleased to support the open source community by making BK-JOB蓝鲸智云作业平台 available. | ||
|
||
Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved. | ||
|
||
BK-JOB蓝鲸智云作业平台 is licensed under the MIT License. | ||
|
||
License for BK-JOB蓝鲸智云作业平台: | ||
-------------------------------------------------------------------- | ||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
documentation files (the "Software"), to deal in the Software without restriction, including without limitation | ||
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and | ||
to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of | ||
the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO | ||
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF | ||
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | ||
IN THE SOFTWARE. |
Oops, something went wrong.