贡献指南

约 200 个字 19 行代码 预计阅读时间 1 分钟

编写流程

下述步骤展示了完整的HPC入门指南编写流程：

# 在你的目录下的合适位置clone该仓库
git clone git@git.sjtu.edu.cn:hpc-start-guide/hpc-start-guide.git
# 也可以使用https协议clone
# git clone https://git.sjtu.edu.cn/hpc-start-guide/hpc-start-guide.git
# 如果你已经clone过本仓库，可以使用该命令拉取最新更改 
git fetch origin
git checkout -b feat1-show # 基于主分支main新建一个分支进行你的更改
... # 进行你的更改并提交
git push origin feat1-show:feat1-show # 将你的更改push到远程仓库
# 如果你希望将你的更改合并到主分支，可访问上述push命令返回的链接，并在网页上提交合并请求
# 管理员将你的更改合并到主分支后，网站将自动更新到你的更改

编写规范

使用fix,feat,chore修饰你的提交，fix代表错误内容的修改，feat代表新内容的添加，chore则为其他修改。例如:

git commit -m "fix: correct typo in the README"
# 也可以使用括号包裹你修改的位置便于定位
git commit -m "fix(README): correct typo"

避免将大文件加入git跟踪，因为其会降低git的性能。如需要将>20MB的文件编入文档可以联系管理员将文件放入web中，并在文档中使用web的链接。

如何编写

HPC入门指南基于mkdocs material项目，其文件遵循markdown语法，但加入了较多新的特性。可以参考官方文档使用这些新特性。

如果你希望在本地配置wiki的预览环境，可按下述步骤进行：

# clone wiki仓库到本地
cd $repo_dir # 进入文档仓库根目录
conda create -n mkdoc python=3.12 # 可修改为你希望使用的python版本
conda activate mkdoc
pip install -r requirements.txt # 安装mkdocs依赖