gian/cubefs
1
0
Fork 0
mirror of https://github.com/cubefs/cubefs.git synced 2026-08-02 02:00:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(doc): Add TestCase Guidelines for contributors

Browse Source 
Signed-off-by: leonrayang <chl696@sina.com>
This commit is contained in:
leonrayang 2024-08-09 10:45:49 +08:00 committed by Victor1319
parent 997014bce3
commit 35f2cbdfa2
2 changed files with 96 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
CONTRIBUTING.md
View File

@ -1,3 +1,16 @@
# Welcome
Welcome to CubeFS!
- [Contributing to CubeFS](#contributing-to-cubefs)
- [Bug Reports](#bug-reports)
- [Workflow](#workflow)
- [Contributor Recruitment](#contributor-recruitment)
- [Development Guide](#development-guide)
- [Coding Style](#coding-style)
- [Commit Message Guidelines](#commit-message-guidelines)
- [Github Workflows](#github-workflows)
# Contributing to CubeFS
## Bug Reports
@ -33,21 +46,58 @@ Please use the fixes keyword in the pull request to associate the pull request w
**Note 3:**<br>
Every pull request that merges code to the master branch needs to be approved by at least one core maintainer for code review and pass all checks (including the DCO check) before it can be merged.
## Development Guide
## Contributor Recruitment
- Current Recruitment：
- Developer activity 2024 ：https://github.com/cubefs/cubefs/issues/3105
- History：
- Summer of Open Source ：https://www.we2shopping.com/blog/2829327/
- Developer activity 2023 ：https://github.com/cubefs/cubefs/issues/1920
### Coding style
# Development Guide
## Coding Style
- Prepare some code checking tools.
``` shell
# gofumpt
> go install mvdan.cc/gofumpt@latest
# golangci-lint
> go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.43.0
```
- Follow the [coding standards](https://go.dev/doc/effective_go) of Go.
- Ensure that your code is formatted using `go fmt` or `gofumpt` before submitting it.
- Ensure that your code is formatted using `gofumpt` before submitting it.
``` shell
> gofumpt -l -w .
```
- Run some indispensable go lints on the project with your new code.
``` shell
> go generate .
# OR run in local docker
> ./docker/run_docker.sh --format
```
- Ensure that each new source file starts with a license header.
- Ensure that there are enough unit tests.
- Ensure that there are enough comments.
- Ensure that there are well-documented comments.
### Commit message guidelines
## Commit Message Guidelines
- Follow the [Angular commit guidelines](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
- Commits must be signed and the signature must match the author.
``` text
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
"close: #<issue_id>"
<BLANK LINE>
<footer>
"Signed-off-by: <name> <email>"
```
- Commits must be signed and the signature must match the author `git commit --signoff`.
- If there is an issue, you need to link to related issues.
- The `subject` and `line of body` should not exceed 100 bytes.
Example:
@ -57,9 +107,39 @@ Example:
Author: users <users@cubefs.groups.io>
Date: Thu Apr 27 09:40:02 2023 +0800
feat(cubefs): this is an example
feat(doc): this is an example
body's first line, explain more details of this commit,
new line if the body is more than 100 bytes.
close: #1
empty or anything else
Signed-off-by: users <users@cubefs.groups.io>
```
```
## TestCase Guidelines
- Clear Test Purpose: Ensure each test case clearly states its purpose and what functionality it is verifying.
- Comprehensive Coverage: Aim for comprehensive coverage, including edge cases, typical use cases, and error conditions.
- Descriptive Names: Use descriptive names for your test functions to indicate what they are testing.
- Automated Tests: Ensure that tests can be run automatically and are integrated into the CI/CD pipeline.
- Consistent Style: Follow consistent coding and testing styles to enhance readability and maintainability.
- Review and Refactor: Regularly review and refactor test cases to keep them relevant and efficient as the codebase evolves.
## Github Workflows
- `codeql`: Basic security code scanning.
- `ci`: Run code format, unit test and coverage, s3 service testing and gosec.
- `check_pull_request`: Check pull request title and new commit messages.
- `goreleaser`: Build release package.
- `slsa-releaser`: Build release package with [SLSA](https://slsa.dev/).
- `release_test`: Run ltp tests before released.
## Development, Testing, and Troubleshooting Guidelines
- Develop Guide [link](https://cubefs.io/docs/master/dev-guide/code.html)
- Testing Guide [link](https://cubefs.io/docs/master/evaluation/env.html)
- Best Practice Series
- [Common Troubleshooting Methods](https://cubefs.io/docs/master/faq/troubleshoot/strategy.html)
- [Common Troubleshooting Scenarios](https://cubefs.io/docs/master/faq/troubleshoot/case.html#common-troubleshooting-scenarios)
- [Common Operational Issues Handling](https://mp.weixin.qq.com/s/cH9xw5sK80RIkkZWpyd4qA)

12
MAINTAINERS.md
View File

@ -3,12 +3,12 @@ This page listed the CubeFS main maintainers and their responsibilities.
| Name | Email | Duty | Organization |
|------------------------------------------------------------------------|-----------------------------------------------------------------|-----------------------------------------------------------------------------|--------------|
| Haifeng Liu ([@bladehliu](https://github.com/bladehliu)) | [bladehliu@qq.com](mailto:bladehliu@qq.com) | Sponsor, Software Architect, steering commitee member | - |
| Weilong Guo ([@awzhgw](https://github.com/awzhgw)) | [guowl18702995996@gmail.com](mailto:guowl18702995996@gmail.com) | Software Architect, steering commitee member | [JD.com] |
| Haifeng Liu ([@bladehliu](https://github.com/bladehliu)) | [bladehliu@qq.com](mailto:bladehliu@qq.com) | Sponsor, Software Architect, steering committee member | - |
| Weilong Guo ([@awzhgw](https://github.com/awzhgw)) | [guowl18702995996@gmail.com](mailto:guowl18702995996@gmail.com) | Software Architect, steering committee member | [JD.com] |
| Shuoran Liu ([@shuoranliu](https://github.com/shuoranliu)) | [shuoranliu@gmail.com](mailto:shuoranliu@gmail.com) | Client | [BEIKE] |
| Xiaochun He ([@xiaochunhe](https://github.com/xiaochunhe)) | [626148589@qq.com](mailto:626148589@qq.com) | Software Architect, steering commitee member | [OPPO] |
| Mofei Zhang ([@mervinkid](https://github.com/mervinkid)) | [mofei2816@gmail.com](mailto:mofei2816@gmail.com) | Metadata, steering commitee member | [JD.com] |
| Liang Chang ([@leonrayang](https://github.com/leonrayang)) | [chl696@sina.com](mailto:chl696@sina.com) | Resource Manager, steering commitee member | [OPPO] |
| Xiaochun He ([@xiaochunhe](https://github.com/xiaochunhe)) | [626148589@qq.com](mailto:626148589@qq.com) | Software Architect, steering committee member | [OPPO] |
| Mofei Zhang ([@mervinkid](https://github.com/mervinkid)) | [mofei2816@gmail.com](mailto:mofei2816@gmail.com) | Metadata, steering committee member | [JD.com] |
| Liang Chang ([@leonrayang](https://github.com/leonrayang)) | [chl696@sina.com](mailto:chl696@sina.com) | Resource Manager, steering committee member | [OPPO] |
| Xuewei Zeng ([@Victor1319](https://github.com/Victor1319)) | [834863182@qq.com](mailto:834863182@qq.com) | Data Storage | [OPPO] |
| Dr.Wei Ding ([@wding109](https://github.com/wding109)) | [wding109@gmail.com](mailto:wding109@gmail.com) | Strategy, Researching | [ByteDance] |
| Dr.Junyuan Zeng ([@jzeng4](https://github.com/jzeng4)) | [jzeng04@gmail.com](mailto:[jzeng04@gmail.com) | Authorization | [LinkedIn] |
@ -63,4 +63,4 @@ This page listed the CubeFS main maintainers and their responsibilities.
[Xiaohongshu]: https://www.xiaohongshu.com/explore
[Chengdu University of Information Technology]: https://english.cuit.edu.cn/
[Hangzhou Dianzi University]: https://en.hdu.edu.cn/main.html
[China United Telecommunications Co]: https://www.chinaunicom.com.cn/
[China United Telecommunications Co]: https://www.chinaunicom.com.cn/