mirror of
https://gitee.com/rulego/rulego.git
synced 2025-12-06 14:59:03 +08:00
chore:update CONTRIBUTION.md
This commit is contained in:
@@ -58,8 +58,23 @@ We are committed to providing an open and inclusive community environment. Pleas
|
||||
5. **Create a Branch**: `git checkout -b my-feature-branch main`.
|
||||
6. **Write Code and Tests**: Add your code and corresponding test cases.
|
||||
7. **Format Code**: Format your code using the `gofmt -s -w .` command.
|
||||
8. **Commit and Push**: Commit your changes using `git add .` and `git commit -s -m "fix: add new feature"`, then push to your forked repository.
|
||||
9. **Create a PR**: Create a PR on Github and ensure you fill in a detailed PR description.
|
||||
8. **Commit the code**: Use `git add .` and `git commit -s -m "fix: add new feature"` to commit the changes.
|
||||
- `feat`: Abbreviation for feature, a new functionality or enhancement.
|
||||
- `fix`: Bug fix.
|
||||
- `docs`: Documentation changes.
|
||||
- `style`: Formatting changes. For example, adjusting indentation, spaces, removing extra blank lines, or adding missing semicolons. In short, changes that do not affect the meaning or functionality of the code.
|
||||
- `refactor`: Code refactoring. Modifications that are neither bug fixes nor new feature additions.
|
||||
- `perf`: Abbreviation for performance, improvements to code performance.
|
||||
- `test`: Changes to test files.
|
||||
- `chore`: Other minor changes. Typically one or two lines of changes, or a series of small changes that belong to this category.
|
||||
|
||||
For more detailed information, please refer to [Conventional Commits](https://www.conventionalcommits.org/zh-hans/v1.0.0/).
|
||||
|
||||
9. **Push the code**: Before committing the code, please first perform a rebase operation to ensure that your branch is synchronized with the main branch of the upstream repository.
|
||||
- `git fetch --all`
|
||||
- `git rebase upstream/main`
|
||||
- Push your branch to GitHub: `git push origin my-fix-branch`
|
||||
10. **Create a PR**: Create a PR on Github and ensure you fill in a detailed PR description.
|
||||
|
||||
### 4.2 Compiling Source Code
|
||||
|
||||
@@ -107,7 +122,9 @@ Use the [RuleGo-Editor](https://editor.rulego.cc/) 、[RuleGo-Example](https://e
|
||||
- [rulego-components-ai](https://github.com/rulego/rulego-ai) : Components for AI scenarios.
|
||||
- [rulego-components-ci](https://github.com/rulego/rulego-ci) : Components for CI/CD scenarios.
|
||||
- [rulego-components-iot](https://github.com/rulego/rulego-iot) : Components for IoT scenarios.
|
||||
- [streamsql]: A sub-project aimed at enhancing the aggregation computing capabilities of edge computing through SQL statements.
|
||||
- [rulego-components-etl](https://github.com/rulego/rulego-components-etl): ETL scenario components.
|
||||
- [streamsql](https://github.com/rulego/streamsql): Subproject for enhancing edge computing aggregation capabilities.
|
||||
- [rulego-marketplace](https://github.com/rulego/rulego-marketplace): Components marketplace.
|
||||
|
||||
### 5.2 Contribute Documentation
|
||||
- Official documentation: [rulego-doc](https://github.com/rulego/rulego-doc) .
|
||||
|
||||
@@ -59,8 +59,22 @@ rulego
|
||||
5. **创建分支**:`git checkout -b my-feature-branch main`。
|
||||
6. **编写代码和测试**:添加你的代码和相应的测试用例。
|
||||
7. **格式化代码**:使用`gofmt -s -w .`命令格式化代码。
|
||||
8. **提交和推送**:使用`git add .`和`git commit -s -m "fix: add new feature"`提交更改,然后推送到你的Fork仓库。
|
||||
9. **创建PR**:在Github上创建PR,并确保填写详细的PR描述。
|
||||
8. **提交代码**:使用`git add .`和`git commit -s -m "fix: add new feature"`提交更改。
|
||||
- feat: feature的缩写, 新的功能或特性
|
||||
- fix: bug的修复
|
||||
- docs: 文档修改
|
||||
- style: 格式修改. 比如改变缩进, 空格, 删除多余的空行, 补上漏掉的分号. 总之, 就是不影响代码含义和功能的修改
|
||||
- refactor: 代码重构. 一些不算修复bug也没有加入新功能的代码修改
|
||||
- perf: performance的缩写, 提升代码性能
|
||||
- test: 测试文件的修改
|
||||
- chore: 其他的小改动. 一般为仅仅一两行的改动, 或者连续几次提交的小改动属于这种
|
||||
|
||||
更多详细信息,您可以参考[约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 。
|
||||
9. **推送代码**:在提交代码之前,请先执行 rebase 操作,以确保您的分支与上游仓库的主分支保持同步。
|
||||
- `git fetch --all`
|
||||
- `git rebase upstream/main`
|
||||
- 将您的分支推送到Github `git push origin my-fix-branch`
|
||||
11. **创建PR**:在Github上创建PR,并确保填写详细的PR描述。
|
||||
|
||||
### 4.2 编译源码
|
||||
|
||||
@@ -106,7 +120,9 @@ go build -tags "with_extend,with_ai,with_ci,with_iot" .
|
||||
- [rulego-components-ai](https://github.com/rulego/rulego-components-ai) :AI场景组件。
|
||||
- [rulego-components-ci](https://github.com/rulego/rulego-components-ci) :CI/CD场景组件。
|
||||
- [rulego-components-iot](https://github.com/rulego/rulego-components-iot) :IoT场景组件。
|
||||
- [streamsql]() : 增强边缘计算聚合计算能力的子项目。
|
||||
- [rulego-components-etl](https://github.com/rulego/rulego-components-etl) :ETL场景组件。
|
||||
- [streamsql](https://github.com/rulego/streamsql) : 增强边缘计算聚合计算能力的子项目。
|
||||
- [rulego-marketplace](https://github.com/rulego/rulego-marketplace) : 组件市场。
|
||||
|
||||
### 5.2 贡献文档
|
||||
- 官网文档:[rulego-doc](https://github.com/rulego/rulego-doc)
|
||||
|
||||
Reference in New Issue
Block a user