CONTRIBUTING(贡献指南)¶
谢谢你想为本仓库贡献笔记和资料!为保持内容整洁与可用性,请按下面步骤和约定提交:
- 基本流程 / Basic flow
- Fork 本仓库,创建 feature 分支(
notes/<course>-<yourname>-<year>)。 - 在你的分支中添加或修改文件,使用
templates/note_template.md作为笔记模板。 -
提交并发起 Pull Request,填写 PR 模板(.github/PULL_REQUEST_TEMPLATE.md)。
-
文件与命名规范 / File & naming conventions
- 笔记文件:保存在对应课程目录下,文件名应包含课程名 + 作者后缀,例如
Topic 1 Innate Immune system (zl_2023).md。 - ZIP 文件:请包含贡献者标识与年份,例
pon复习资料_lxrwyqlxf_2022.zip。
重要:本仓库不再接收 ZIP 文件本体(太大,不适合放在 GitHub)。
- 请将 ZIP 上传到 Google Drive(或 Zenodo 等外部存储)。
-
在
ZJE_Collection/ZIPS_INDEX.md中补充条目/状态,并在ZJE_Collection/zip_contents/中添加对应的“内容页”(可写明 ZIP 内包含哪些文件,或课程范围)。 -
如果包含一些比较难以网站直接读取的格式,可以使用zip作为上传途径,如果特别希望直接在网上可以阅读,md格式或者pdf格式可能最好。
附:更多模板见 templates/note_template.md。
感谢贡献! — CHENyiru & contributors