docs: 添加贡献指南,说明问题报告和代码贡献流程

This commit is contained in:
MKStoler1024 2025-02-01 15:13:52 +00:00
parent 58492b3d8f
commit 90b765573d

58
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,58 @@
# 贡献指南
感谢您对 ExamCloudSchedule 项目的关注和贡献!我们欢迎各种形式的贡献,包括报告问题、提交功能请求和贡献代码。请按照以下步骤进行贡献:
## 报告问题&提交功能请求
1. 请先在 [issue 列表](https://github.com/ExamAware/ExamCloudSechdule/issues) 中搜索,确保问题或者功能请求尚未被开发者受理。
2. 如果没有找到相关问题,请创建一个新的 issue并提供尽可能详细的信息包括复现步骤、预期行为和实际行为如果没有找到相关请求请创建一个新的 issue并详细描述您希望添加的功能及其用途。
## 贡献代码
1. Fork 本仓库到您的 GitHub 账户。
2. 克隆您 fork 的仓库到本地:
```bash
git clone https://github.com/your-username/ExamCloudSechdule.git
```
3. 创建一个新的分支以进行您的更改:
```bash
git checkout -b feature/your-feature-name
```
4. 进行代码更改,并确保所有现有测试通过。
5. 提交您的更改:
```bash
git commit -m "描述您的更改"
```
> [!TIP]
>
> 在本代码仓库提交时,请尽量遵守[约定式提交规范](https://www.conventionalcommits.org/zh-hans/v1.0.0/)。
6. 将更改推送到您的 fork 仓库:
```bash
git push origin feature/your-feature-name
```
7. 创建一个 Pull Request并描述您的更改内容。
## 代码规范
请确保您的代码符合以下规范:
- 遵循项目的代码风格。
- 提供必要的注释和文档。
- 确保所有现有测试通过,并为您的更改添加新的测试。
## 许可证
通过贡献代码,您同意您的贡献将采用本项目的 [MIT 许可证](../LICENSE)。
感谢您的贡献!
ExamAware 团队