From b658d0db49081b0b9f3d87942b2a44431c1b1099 Mon Sep 17 00:00:00 2001 From: leonrayang Date: Fri, 9 Aug 2024 10:45:49 +0800 Subject: [PATCH] feat(doc): Add TestCase Guidelines for contributors Signed-off-by: leonrayang --- CONTRIBUTING.md | 8 ++++++++ MAINTAINERS.md | 12 ++++++------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83683619e..732e4de39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -118,6 +118,14 @@ Date: Thu Apr 27 09:40:02 2023 +0800 Signed-off-by: users ``` +## 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. diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 9200a6b0c..ff9f011d2 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -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/ \ No newline at end of file +[China United Telecommunications Co]: https://www.chinaunicom.com.cn/