Pre release/v0.3.0 (#23)

* optimize: hook update and better check for 404

* english translation; better README

* import the pr time check

Author: Charliechen114514

.githooks/pre-commit

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+ROOT="$(git rev-parse --show-toplevel)"
+cd "$ROOT"
+
+log() {
+    printf '[pre-commit] %s\n' "$1"
+}
+
+fail() {
+    printf '[pre-commit] ERROR: %s\n' "$1" >&2
+    exit 1
+}
+
+mapfile -t STAGED_FILES < <(git diff --cached --name-only --diff-filter=ACMR)
+
+if [ "${#STAGED_FILES[@]}" -eq 0 ]; then
+    log "No staged files. Nothing to check."
+    exit 0
+fi
+
+mapfile -t CPP_FILES < <(
+    printf '%s\n' "${STAGED_FILES[@]}" |
+        grep -E '\.(c|cc|cpp|cxx|h|hh|hpp|hxx)$' || true
+)
+
+if [ "${#CPP_FILES[@]}" -gt 0 ]; then
+    command -v clang-format >/dev/null 2>&1 ||
+        fail "clang-format is required to commit C/C++ files."
+
+    DIRTY_CPP_FILES=()
+    for file in "${CPP_FILES[@]}"; do
+        if ! git diff --quiet -- "$file"; then
+            DIRTY_CPP_FILES+=("$file")
+        fi
+    done
+
+    if [ "${#DIRTY_CPP_FILES[@]}" -gt 0 ]; then
+        printf '[pre-commit] These staged C/C++ files also have unstaged changes:\n' >&2
+        printf '  %s\n' "${DIRTY_CPP_FILES[@]}" >&2
+        fail "stage or stash those unstaged changes before committing so the hook does not include them accidentally."
+    fi
+
+    log "Formatting ${#CPP_FILES[@]} staged C/C++ file(s) with clang-format..."
+    clang-format -i -- "${CPP_FILES[@]}"
+    git add -- "${CPP_FILES[@]}"
+fi
+
+command -v python3 >/dev/null 2>&1 ||
+    fail "python3 is required to update translation coverage."
+
+if ! git diff --quiet -- README.md; then
+    fail "README.md has unstaged changes; stage or stash them before committing so coverage updates stay explicit."
+fi
+
+log "Updating translation coverage in README.md..."
+python3 scripts/coverage.py --update
+git add README.md
+
+log "Done."

.github/workflows/build-check.yml

@@ -0,0 +1,41 @@
+name: Build Check
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Restore build cache
+        uses: actions/cache@v4
+        with:
+          path: site/.vitepress/.build-cache
+          key: vitepress-build-${{ hashFiles('documents/**') }}
+          restore-keys: vitepress-build-
+
+      - name: Build
+        run: pnpm build
+        env:
+          NODE_OPTIONS: --max-old-space-size=6144
+          BUILD_CONCURRENCY: 8

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
-# Pre-commit hooks configuration
-# Install: pip install pre-commit
-# Enable: pre-commit install
+# Optional pre-commit framework checks.
+# The default one-step commit automation lives in .githooks/pre-commit.
+# Install the native Git hook with: pnpm hooks:install
 
 repos:
   # Markdown linting

CONTRIBUTING.md

@@ -6,9 +6,38 @@
 
 1. Fork 本仓库
 2. 创建你的特性分支 (`git switch -c feature/amazing-feature`)
-3. 提交更改 (`git commit -m '添加某功能'`)
-4. 推送到分支 (`git push origin feature/amazing-feature`)
-5. 创建 Pull Request
+3. 安装本地 Git hook (`pnpm hooks:install` 或 `scripts/setup_precommit.sh`)
+4. 提交更改 (`git commit -m '添加某功能'`)
+5. 推送到分支 (`git push origin feature/amazing-feature`)
+6. 创建 Pull Request
+
+## 提交前自动化
+
+本仓库使用可追踪的原生 Git hook，配置位于 `.githooks/pre-commit`。安装后，每次 `git commit` 前会自动执行：
+
+- 对已暂存的 C/C++ 源文件和头文件运行 `clang-format -i`
+- 运行 `python3 scripts/coverage.py --update` 检查英文翻译覆盖率并更新 `README.md`
+- 对 hook 自动修改的文件执行 `git add`，因此通常不需要因为格式化或覆盖率徽章变化再次手动提交
+
+首次克隆仓库后运行：
+
+```bash
+pnpm install
+pnpm hooks:install
+```
+
+如果不使用 pnpm，也可以直接运行：
+
+```bash
+scripts/setup_precommit.sh
+```
+
+hook 依赖本机已安装：
+
+- `python3`：用于翻译覆盖率统计
+- `clang-format`：用于 C/C++ 代码格式化
+
+为了避免把未准备提交的内容一起带入 commit，如果已暂存的 C/C++ 文件或 `README.md` 同时还有未暂存改动，hook 会停止并提示先整理工作区。确实需要临时跳过 hook 时，可以使用 `git commit --no-verify`，但不建议在 PR 提交中长期绕过。
 
 ## 文章规范