2. For Contributor ‐ 对贡献者

介绍

这里是华中科技大学开源镜像站的贡献指南。竭诚为广大开发者提供部分在贡献时需要注意的东西和部分对贡献有帮助的内容。

Commit Message 规范

在给镜像站做出贡献时，请务必遵守conventionalcommits规范。您可使用VSCode插件方便的遵循该规范。

Varcode的使用

文档中代码块，可以使用以下变量

${_http} http 协议 ${_domain} 站点域名 ${_backup_dir}（仅限 cli 生成工具）备份文件存储路径

同时，可以参考debian，rocky文档，使用JS代码定义特殊选项（比如SUDO，版本选择）

实操

wget ${_http}${_domain}/status.json

会渲染为：

wget http://mirror.husts.edu.cn/status.json

如果开启了https，会渲染为

wget https://mirror.husts.edu.cn/status.json

添加应用至应用下载页面

编辑 ci/releases.conf，根据以下格式添加应用：

[应用名称]
name=应用名称
path=路径/**
exp=正则表达式（用于匹配文件）
version=1
variant=2

添加小灯泡按钮至镜像列表

当您pr后查看预览，发现被您添加文档的镜像在主页没有显示小灯泡/cli按钮，您可根据以下步骤修改：

修改方法

按以下格式，在 MirrorsMeta 数组中修改对应项（如无请创建）：

{ id: '镜像ID', description: '镜像介绍', helpID: '帮助文档md名称（不含.md）' },

在本地开发时预览镜像列表

执行 yarn build-preview 获取模拟数据，再启动预览。

动态/博客（Blog）

在新增/删除/更改镜像时，必须编写blog，编写方法如下：
在 /blog/2025 下创建文件，名称格式为：月-日-change.md 内容示例（根据你的需求更改）：

---
title: 镜像变更通知
authors: paulkm
---

为更好地满足用户需求并优化资源分配，我们对镜像站的同步策略进行了如下调整。

1. 删除了以下镜像：
   - Anolis

2. 新增同步：
   - 新增了部分 github-releases 的同步，目前开启了 `rustdesk/rustdesk`, `ip7z/7zip` 和 `llvm/llvm-project` 项目的同步
   - 新增了 radxa-deb 的同步

我们将持续关注镜像服务的稳定性和资源使用效率，为您提供更高质量的访问体验。感谢大家一直以来的支持与理解。
``