Skip to content

CODE_OF_CONDUCT.md

Latest commit

 

History

History
239 lines (153 loc) · 7.93 KB

CODE_OF_CONDUCT.md

File metadata and controls

239 lines (153 loc) · 7.93 KB
Raw

代码规范

课程页面

---
title: 课程名
course_code: 课程代码
---
## 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)

课程页面整理规则:

  • 课程页面按学期组织。每个学期使用 ## 20xx-20xx学年x学期 作为二级标题。
  • 每个学期下优先放 ### 试卷，试卷链接原则上指向本仓库中的 Markdown 试卷文件，不直接链接 PDF、图片或其他原始文件。
  • 试卷原始 PDF、图片可以作为校对来源保存在资源仓库中，但展示入口应为 Markdown 试卷。
  • 教师评价和属于某位教师的教学资源放在对应 ### 教师名 下；该教师暂无评价时可以留空。
  • 属于某位教师的课件、作业、补充资料等放在该教师标题下的 #### 教学资源 中。
  • 无法确认教师归属的教学资源、教材、参考资料等，统一放在最后的 ## 推荐教材与参考资料 中。
  • ## 推荐教材与参考资料 用于课程通用资料，不再按教师拆分。

试卷

样式比较复杂, 具体参照 网络安全数学基础（一）/2023-2024学年下学期期末.md

文件命名

  • 试卷文件名按学年、学期、考试类型命名, 例如 2023-2024学年下学期期末.md。
  • 文件名中不写 _含答案、卷别、教师、回忆等版本信息。是否含答案、卷别、教师、来源不确定性等信息写在 Markdown 正文中。
  • 同一学年、同一学期、同一考试类型下存在 A/B 卷、不同教师版本、部分含答案或其他并行版本时, 不要拆成多个文件, 应合并到同一个 Markdown 文件中。例如:
---
title: 2023-2024学年下学期期末
---

## 2023-2024学年下学期期末试卷（A）（含答案）

...

***

## 2023-2024学年下学期期末试卷（B）

...

***

## 2023-2024学年下学期期末试卷（A）——张xx（含答案）

...
  • 课程页面中也只挂一个链接:
- [2023-2024学年下学期期末试卷](./2023-2024学年下学期期末)
  • 课程页面的链接文字不写是否含答案、卷别或教师；这些信息只写在对应试卷 Markdown 正文中。

内容格式

  • 试卷正文应尽量尊重原卷题面, 不要擅自添加原卷没有的小标题。
  • 原卷中有大题标题时, 使用 ### 一、选择题、### 二、填空题 等格式。
  • 原卷中只有题号时, 直接使用 1.、2. 等编号即可。
  • 卷别、教师、是否含答案或版本差异写在 Markdown 正文标题中, 例如 ## 2023-2024学年下学期期末试卷（A）、## 2023-2024学年下学期期末试卷（A）——张xx（含答案）。
  • 原题中标注的总分、大题分值、小题分值必须保留; 参考答案或评分标准中标注的步骤分值、扣分规则也必须写入对应答案中, 不要省略。
  • 同一大题内的题目之间使用缩进 4 个空格的分隔线 ***；大题之间使用顶格分隔线 ***。例如:
1. 第一题题面

    ***

2. 第二题题面

***

### 二、填空题
  • 答案放在对应题目下方的折叠块中:
<details>
<summary>解：</summary>

答案内容

</details>
  • 若答案折叠块位于编号题目内, <details>、<summary>、答案正文和 </details> 整体缩进 4 个空格, 与题内分隔线保持一致。
  • 选择题选项建议使用 A/B/C/D 分行书写, 并在选项之间空一行; 数学公式使用 LaTeX。
  • 试卷正文中不要滥用反引号。普通英文单词、英文缩写、IP 地址、子网掩码、CIDR 表项、比特串、协议名、设备名等, 若原卷就是普通正文, 一般也按普通正文书写; 分式、上下标、带单位的计算式、不等式、函数表达式等数学内容优先使用 LaTeX。
  • 独立出现的数量与英文单位优先使用 LaTeX, 例如 $100\ \text{Mbps}$、$125\ \text{B}$、$100\ \text{m}$、$5\ \text{ms}$; 中文单位通常保持普通正文, 例如 1 微秒、15000 字节、32 位, 不必为了统一而写成 LaTeX。但像 100BASE-TX、IPv4、CSMA/CD 这类协议名、标准名或固定术语通常保持普通正文即可。
  • 填空横线优先使用 LaTeX: $\underline{\qquad}$。
  • 横线上带编号的填空优先将编号写入下划线中, 例如 $\underline{\qquad(1)\qquad}$、$\underline{\qquad(2)\qquad}$。
  • 不确定或来自回忆的题目, 应在正文中用 ### 说明 标明来源不确定性。
  • 原卷或参考答案疑似有误时, 可在对应题目或答案下使用 Docusaurus 提示块说明, 但不要替代原卷原文或原参考答案。例如:
    :::tip
    原参考答案此处疑似有误: 题目条件为 ..., 因此应为 ...。
    :::

若原卷的大题标题本身就是题目, ### 后只写题号和分值, 题面放在标题下方。例如:

### 一、（10 分）

设 $A$ 为矩阵, 求 $\det(A)$。

1. 小问题面

    <details>
    <summary>答案：</summary>

    答案内容

    </details>

    ***

选择题推荐排版:

1. 题面（ ）。

    A. 选项 A

    B. 选项 B

    C. 选项 C

    D. 选项 D

    <details>
    <summary>答案：</summary>

    A

    </details>

    ***

编号题目内的答案与题间分隔线推荐排版:

1. 题面

    <details>
    <summary>答案：</summary>

    报文交换网、分组交换网

    </details>

    ***

图片处理

  • 题目中不可缺少的图片, 如拓扑图、时序图、协议报文格式、坐标图、表格截图等, 应放入课程目录下的 images/ 目录。
  • 图片文件名应能对应试卷、卷别和题号, 例如:
images/2023-2024学年下学期期末_A_第4题.png
images/2023-2024学年下学期期末_B_第6题.png
  • 若试卷没有 A/B 卷等卷别信息, 文件名中省略卷别; 若同一试卷中不同大题存在相同题号, 可在题号前加入题型以避免歧义, 例如:
images/2024-2025学年上学期期中_选择题_第4题.png
images/2024-2025学年上学期期中_分析与设计题_第2题.png
  • 同一题有多张必要图片时, 在题号后加 _1、_2 等序号; 答案或解析中的必要图片可在题号后加 _答案, 例如:
images/2023-2024学年下学期期末_B_第6题_1.png
images/2023-2024学年下学期期末_B_第6题_2.png
images/2024-2025学年上学期期中_分析与设计题_第2题_答案_1.png
images/2024-2025学年上学期期中_分析与设计题_第2题_答案_2.png
  • Markdown 中使用相对路径引用图片:
![A卷第4题图](./images/2023-2024学年下学期期末_A_第4题.png)
  • 页眉、学校 logo、空白答题框、装饰线等非题目必要内容通常不需要保留。
  • 协议伪代码、短程序、ASCII 图、可读性好的波形图优先使用代码块, 不必截图; 复杂拓扑图、坐标图、手写图、表格截图等无法稳定转写的内容再放入 images/。

有搞不懂样式怎么写的可以询问开发团队