上传与贡献指南

本文介绍了向本项目贡献资料的准则与方法。

资料形式

我们的初衷是方便同学们的期末复习，接受的资料的形式包括但不限于：

但是，我们不接受以下形式的资料：

我们建议的资料格式为 PDF 和 Markdown。这样的资料可以直接在线预览，也方便其他同学在线查看。如果您的资料是其他格式，我们建议您将其转换为 PDF 或 Markdown 格式。

对于 PowerPoint 演示文稿、Word 文档等格式的资料，您可以使用以下方法转换为 PDF 格式：

在转换完成后，您还应该对其进行压缩，以减少文件大小。上面提供的 HiPDF、iLovePDF 等平台就提供了压缩功能。如果您偏好使用命令行工具，您可以使用 theeko74/pdfc。

您应该参考《资料分类说明》，将资料存放到正确的仓库中。在存放资料时，您应当对资料进行适当的重命名：

使用 第1章-1-课程介绍 代替 第一章-1-课程介绍 有利于资料的自动排序；
在您能确定一份资料的时间信息时，为资料添加适当的后缀（特别是针对试卷），例如使用 21-22-1 表示它是 2021-2022 学年第 1 学期 的资料（考虑到长度，不再推荐使用 2021-2022-1 这样的形式）。

我们希望分类存放资料，以便同学们更快地找到自己需要的资料。一个好的习惯是，将课件、复习资料、试卷等不同类型的资料放在不同的文件夹下。

特别地，对于 NJUPT-General-Free-Exams 通识课资料仓库，请遵循下面的规则：

对于非 Markdown 格式的资料，您应该将其放入 /public/ 目录下的相应子目录下。举例而言，如果您希望贡献 “毛概” 这门课的 2024 年的复习资料及期末试卷，可能的目录结构如下：

如果您希望贡献的资料是 Markdown 格式的，我们建议您将其放入 /src/content/docs/reserved/ 目录下。这样，您的资料将直接显示在门户网站上。

为了使本门户网站能识别您的资料，您必须为您的 Markdown 文件添加 YAML 头部（Frontmatter），以提供更多的信息。例如：

---
title: 文件标题（必选）
description: 内容描述（可选）
---

为了向仓库贡献资料，您需要首先 Fork 相应的仓库，对其做出更改并推送（Push），然后，发起一个拉取请求（Pull Request），请求我们拉取（Pull）您的更改内容。

下面是一个在 GitHub 网站进行操作的完整示例：

前往您想要贡献的仓库首页，点击右上角的 Fork 按钮，在下一个页面点击右下角的 Create fork 按钮。如果您已经进行过此操作，那么您应该点击右上角的头像，在下拉栏中点击 Your repositories，之后找到并点击相应的仓库。页面会自动跳转到 Fork 后的仓库，您应该在左上角看到 forked from ... 字样。
打开想要上传到的文件夹，点击右上角的 Add file，在下拉栏中选择 Upload files。
将想要上传的 经过压缩的 文件或文件夹拖入页面中央的方框内，并等待上传完成。
在 Commit changes 卡片内，填写您的提交说明，可选地，您还可以附加更多说明。在最下方，选择 Create a new branch for this commit and start a pull a request，并在下方填入一个使用英文和 - 符号写出的具有描述性的名称。

Commit changes

在下一个页面，参考 NJUPT-General-Free-Exams #34 或 NJUPT-CST-Free-Exams #22 描述您此次贡献的内容。

您也可以参考（将文章中的 “代码” 理解为您希望贡献的文件即可）：

为了更好地协作，我们建议您开启 “允许维护员编辑”，这样，我们就可以直接修改您的 PR。