docs: readme, coc, contributing

This commit is contained in:
KirisameVanilla 2025-09-03 00:27:38 +08:00
parent 6933c52947
commit f9652d5e1e
3 changed files with 69 additions and 6 deletions

58
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,58 @@
# 代码规范
## 课程页面
``` markdown
---
title: 课程名
category:
- 开课学院
- 课程类别
tag:
- 课程相关的词条
---
## 20xx-20xx学年x学期
### 试卷
- [20xx-20xx学年x学期期末试卷](url to markdown)
### 教师 A
- 一些教师评价(前人写过可以不写了)
- 所以这里可以留空
#### 教学资源
- [课件 2022级更新 (3-1 到 5)](https://drive.vanillaaaa.org/SharedCourses/%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B%E5%AD%A6%E9%99%A2/%E4%BF%A1%E6%81%AF%E5%AE%89%E5%85%A8%E6%95%B0%E5%AD%A6%E5%9F%BA%E7%A1%80/2022%E7%BA%A7)
### 教师 B
## 20xx-20xx学年x学期
### 试卷
- [20xx-20xx学年x学期期末试卷](url to markdown)
### 教师 A
- 一些教师评价
- 所以这里可以留空
#### 教学资源
- [课件 2022级更新 (3-1 到 5)](https://drive.vanillaaaa.org/SharedCourses/%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B%E5%AD%A6%E9%99%A2/%E4%BF%A1%E6%81%AF%E5%AE%89%E5%85%A8%E6%95%B0%E5%AD%A6%E5%9F%BA%E7%A1%80/2022%E7%BA%A7)
### 教师 C
## 推荐教材与参考资料
- [教材](url to file)
```
## 试卷
样式比较复杂, 具体参照 [信息安全数学基础(一)/2023-2024学年下学期期末_含答案.md](https://raw.githubusercontent.com/BetterECNU/SharedCourses/refs/heads/main/docs/courses/软件工程学院/信息安全数学基础(一)/2023-2024学年下学期期末_含答案.md)
有搞不懂样式怎么写的可以询问开发团队

9
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,9 @@
# 贡献指南
## 规范
[点我查看具体规范](https://github.com/BetterECNU/SharedCourses?tab=coc-ov-file)
- 命名规范: 建议采用 `科目_院系_学期_考试类型_其他信息.格式` 方式命名
- 资料类型: 试卷, 答案, 讲义等均可提交, 试卷及答案使用 `Markdown` 书写, 讲义经由开发团队储存至私有服务器之后以外链的方式引用
- Commit Message 说明: 如 `feat: 软件工程学院-计算机系统`, `fix: 软件工程学院-计算机系统试卷书写错误` 等, 不符合规范的 Message 将被开发团队使用 Squash Merge 重新撰写

View File

@ -19,11 +19,7 @@
## 贡献指南 ## 贡献指南
### 规范 [点我查看贡献指南](https://github.com/BetterECNU/SharedCourses?tab=contributing-ov-file)
- 命名规范: 建议采用 `科目_院系_学期_考试类型_其他信息.格式` 方式命名
- 资料类型: 试卷, 答案, 讲义等均可提交, 试卷及答案使用 `Markdown` 书写, 讲义经由开发团队储存至私有服务器之后以外链的方式引用
- Commit Message 说明: 如 `feat: 软件工程学院-计算机系统`, `fix: 软件工程学院-计算机系统试卷书写错误` 等, 不符合规范的 Message 将被开发团队使用 Squash Merge 重新撰写
### 贡献者 ### 贡献者
@ -31,7 +27,7 @@
## 项目结构 ## 项目结构
``` ``` markdown
docs/ docs/
├── courses/ # 课程资料目录 ├── courses/ # 课程资料目录
└── .vuepress/ # 项目配置 └── .vuepress/ # 项目配置