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 leonrayang
parent 45a486ec22
commit b658d0db49
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -118,6 +118,14 @@ Date: Thu Apr 27 09:40:02 2023 +0800
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.

10
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] |