2.4 KiB
2.4 KiB
代码库合集分类方案
版本:v1 · 2026-08-16 用途:为"关注的代码库"合集(codebase-collection)定义统一的分类与命名规范。
分类原则
- 按领域分类,与服务器运维/业务场景对齐(音视频、网络、AI、前端等)。
- 子模块路径用英文 slug(小写、连字符),避免中文路径在工具链(CI、脚本、URL)中的兼容问题;中文说明只出现在文档里。
- 一个仓库只能归入一个主分类;拿不准时归入
other/,后续再调整。 - 每个收录项必须填写:名称、镜像地址(git.vanusys.com)、上游地址、用途、关注原因。
分类目录(一级)
| 分类 slug | 中文名 | 收录范围 | 示例 |
|---|---|---|---|
realtime |
音视频与实时通信 | SFU、WebRTC、会议、直播、远程桌面 | LiveKit、RustDesk |
network |
网络与隧道 | 隧道、代理、流量转发、防火墙、NAT | traffic-mix、frp、软路由相关 |
frontend |
前端与设计系统 | UI 框架、设计系统、组件库、AI 前端 | astryx(Meta 设计系统) |
ai |
AI 与智能体 | LLM、Agent、机器人、推理、RAG | QQbot、Agent 框架 |
infra |
基础设施与中间件 | 数据库、缓存、消息队列、容器、K8s | PostgreSQL、Redis、Docker 相关 |
ops |
运维与自动化 | 监控、日志、备份、CI/CD、配置管理 | Prometheus、Ansible |
internal |
内部自研 | 我们自己在 git.vanusys.com 上维护的仓库 | ai-ops-docs、自研客户端 |
other |
其他/待分类 | 暂未归类的仓库 | — |
命名规范
- 子模块路径:
<分类slug>/<仓库名>,例如frontend/astryx、realtime/livekit。 - 镜像仓库名(git.vanusys.com 上,统一放 VanuSystems-Mirror 组织):
<上游组织>-<仓库名>,例如facebook-astryx、rustdesk-rustdesk-server、livekit-livekit;镜像仓库公开。 - 合集清单表:README 的"收录清单"为唯一权威清单,分类变更同步更新该表。
收录流程
- 把仓库加入"收录清单"表格(含分类)。
- 在 git.vanusys.com 创建镜像仓库(或由同步脚本自动建仓)。
- 本机执行镜像同步(见
同步方案.md)。 - 在合集中执行
git submodule add <镜像地址> <分类>/<仓库名>,提交收录。