diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8548ab5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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) + +有搞不懂样式怎么写的可以询问开发团队 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..de655b9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# 贡献指南 + +## 规范 + +[点我查看具体规范](https://github.com/BetterECNU/SharedCourses?tab=coc-ov-file) + +- 命名规范: 建议采用 `科目_院系_学期_考试类型_其他信息.格式` 方式命名 +- 资料类型: 试卷, 答案, 讲义等均可提交, 试卷及答案使用 `Markdown` 书写, 讲义经由开发团队储存至私有服务器之后以外链的方式引用 +- Commit Message 说明: 如 `feat: 软件工程学院-计算机系统`, `fix: 软件工程学院-计算机系统试卷书写错误` 等, 不符合规范的 Message 将被开发团队使用 Squash Merge 重新撰写 diff --git a/README.md b/README.md index fde5713..50494fe 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,7 @@ ## 贡献指南 -### 规范 - -- 命名规范: 建议采用 `科目_院系_学期_考试类型_其他信息.格式` 方式命名 -- 资料类型: 试卷, 答案, 讲义等均可提交, 试卷及答案使用 `Markdown` 书写, 讲义经由开发团队储存至私有服务器之后以外链的方式引用 -- Commit Message 说明: 如 `feat: 软件工程学院-计算机系统`, `fix: 软件工程学院-计算机系统试卷书写错误` 等, 不符合规范的 Message 将被开发团队使用 Squash Merge 重新撰写 +[点我查看贡献指南](https://github.com/BetterECNU/SharedCourses?tab=contributing-ov-file) ### 贡献者 @@ -31,7 +27,7 @@ ## 项目结构 -``` +``` markdown docs/ ├── courses/ # 课程资料目录 └── .vuepress/ # 项目配置