跳转至

GitHub 仓库创建与配置手册

本文档说明在 GitHub 上创建 drill-eval 仓库后,如何配置仓库元数据(描述、Topics、主页链接等)。


1. 创建仓库(网页操作)

  1. 登录 GitHub → 点击右上角 +New repository
  2. 填写:
  3. Owner:你的 GitHub 用户名
  4. Repository namedrill-eval
  5. Description

    对齐 GB/T 46792-2025《突发事件应急演练评估指南》的开源方法论与轻量 SaaS
    面向学校、医疗、园区、中小企业;提供白标 OEM / 联合交付合作
    
  6. Private / Public:建议选 Public(ToB 引流项目,公开有助于 SEO)

  7. Add a README file:不要勾(我们已有 README.md,推上去会冲突)
  8. Add .gitignore:不选(我们已有完整的 .gitignore)
  9. License:选 AGPL-3.0(与 LICENSE 文件对应)

  10. 点击 Create repository


2. 创建后立即配置(Settings → General)

在仓库 Settings 页面填写:

2.1 Description(仓库说明)

对齐 GB/T 46792-2025 的应急演练评估 SaaS | 10 模块报告 | 量化指标 | 整改闭环 | 白标 OEM 合作

2.2 Topics(主题标签)

这是 GitHub 搜索发现最重要的字段,选填 5-8 个:

gbt46792
emergency-drill
emergency-management
safety-compliance
evaluation-platform
cloudflare-workers
react19
multi-tenant
saas-template
gb-t-46792
应急演练
应急评估
安全合规

Topics 会出现在仓库首页右侧,也会出现在 GitHub 搜索结果中,是低竞争关键词 SEO 的一部分。

2.3 Website(网站链接)

Website 字段填写你的 Cloudflare Pages 文档站地址:

https://docs.drill-eval.com

(上线 Cloudflare Pages 后填写真实域名,未上线前可先空着)

2.4 Features

  • Issues(启用 Issues,用于合规咨询 / 合作 / Bug 追踪)
  • Pull Requests(启用 PR)
  • Projects(可选,用于看板管理)

2.5 Merge button

建议:取消勾"Allow merge commits",强制使用 Squash and Merge 保持历史整洁。


3. 设置 Issues 模板

在仓库创建完成后,.github/ISSUE_TEMPLATE/ 目录的文件会自动生效。

如果 GitHub 没有自动识别(有时需要手动创建 .github/ISSUE_TEMPLATE 目录而非文件),可以去仓库页面: Settings → Features → Customized templates → 右上角 Settings 图标 → 选择对应模板


4. 设置仓库徽章(可选)

README.md 顶部加入徽章行(提升专业感)。在 GitHub 上推荐用 ** shields.io** 生成的徽章:

[![GB/T 46792-2025](https://img.shields.io/badge/Standard-GB%2FT%2046792--2025-blue?style=flat-square)](https://openstd.samr.gov.cn/)
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-orange?style=flat-square)](LICENSE)
[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-green?style=flat-square)](LICENSE-docs)
[![Cloudflare Workers](https://img.shields.io/badge/Cloudflare-Workers-orange?style=flat-square)](https://workers.cloudflare.com/)
[![Standards: 18 Quant Metrics](https://img.shields.io/badge/Quant%20Metrics-18%20%20indicators-yellow?style=flat-square)](docs/articles/03-量化指标清单.md)

徽章不影响功能,但会给来访者"这是一个认真维护的项目"的第一印象。


5. 关于仓库可见性(Public vs Private)的决策

选项 优点 缺点
Public(公开) LLM SEO + 百度/Google SEO、GitHub Stars 是社会证明、可被搜索发现 竞品可以直接看到你的方法论和代码
Private(私有) 竞品保护 无法享受开源 SEO 红利,Stars 为 0

建议:ToB 引流项目选 Public。你真正的护城河是国标理解深度 + 客户关系 + 执行力,不是代码本身。


6. GitHub Actions 自动化(可选)

目前文档站已切换到 Cloudflare Pages 自动部署,不再需要 GitHub Actions。

如果你将来想在 GitHub 上做以下事情,可以配置 Actions:

6.1 自动同步 Stars 徽章

用 shields.io 徽章,无需 Actions。

6.2 定期抓取新国标更新

# .github/workflows/check-standard.yml
name: Check Standard Updates
on:
  schedule:
    - cron: '0 8 1 * *'  # 每月 1 日 8 点检查
  workflow_dispatch:

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - name: 检查标准信息
        run: |
          echo "GB/T 46792-2025 于 2026-07-01 实施"
          echo "建议:每年 1 月 / 6 月各做一次标准解读更新"

7. Push 后的初始化序列

cd /path/to/drill-eval

# 1. git init(如果还没 init 的话)
git init

# 2. 添加远程仓库(把下面换成你的实际 GitHub 用户名)
git remote add origin https://github.com/你的用户名/drill-eval.git

# 3. 添加所有文件(.gitignore 已生效,敏感文件自动排除)
git add .

# 4. 首次提交
git commit -m "feat: initial commit - drill-eval v1 + docs + methodlogy"

# 5. 推送(GitHub 默认分支名是 main,如果提示用 master 改成 main)
git branch -M main
git push -u origin main

8. 推送后立刻做的事

  1. 设置仓库 Description 和 Topics(第 2 步)
  2. 在 README 顶部加徽章行(第 4 步)
  3. 验证 .gitignore 生效:推送后去 GitHub 仓库页面,确认 node_modules/brd.mdGBT+46792-2025.pdf 不在文件列表中
  4. 创建第一个 Release:Tags → Create a new release → v0.1.0 → "Initial release with v1 MVP + docs"
  5. 配置 Cloudflare Pages(见 docs/Cloudflare-Pages部署指南.md
  6. 提交到开源中国 / 码云(国内开发者发现入口):
  7. 开源中国:https://www.oschina.net/project/add
  8. 码云:https://gitee.com/projects/new