mirror of
https://github.com/rustfs/rustfs.git
synced 2026-07-27 16:48:58 +00:00
Zhengchao An
d1db9a10cd
Agent-instruction and architecture docs had drifted from the code: - CLAUDE.md: slim to commands + pointers; fix wrong claim that `make pre-commit` is the full pre-PR gate (that is `make pre-pr`); drop stale pre-#3929 file paths and merged bug narratives - AGENTS.md: drop dead `rust-refactor-helper` skill rule and the hand-maintained (already stale) scoped-AGENTS index; link architecture docs from Sources of Truth - .github/AGENTS.md: replace the outdated copied CI command matrix with a pointer to ci.yml - crates/AGENTS.md: merge duplicated Testing sections - ARCHITECTURE.md: resolve the utils->config contradiction (edges are removed), mark volatile counts as snapshots, fix a bad path - docs/architecture: add README router; move one-shot plans/trackers (rebalance-decommission phases, migration-progress ledger, PR template) to docs/superpowers/plans with archive headers; fix stale source paths in kept inventories (core/sets.rs, core/pools.rs, store/mod.rs, startup_* split from #3671) - docs/operations/tier-ilm-debugging.md: extracted tier debugging playbook with corrected paths - scripts/check_doc_paths.sh: new guard failing pre-commit/pre-pr when instruction/architecture docs reference nonexistent file paths - .claude/skills: add tier-debug and arch-checks repo skills; .gitignore now keeps .claude/skills and docs/operations committable Verification: ./scripts/check_doc_paths.sh, ./scripts/check_architecture_migration_rules.sh (both pass) Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
26 lines
1021 B
Markdown
26 lines
1021 B
Markdown
# GitHub Workflow Instructions
|
|
|
|
Applies to `.github/` and repository pull-request operations.
|
|
|
|
## Pull Requests
|
|
|
|
- PR titles and descriptions must be in English.
|
|
- Use `.github/pull_request_template.md` for every PR body.
|
|
- Keep all template section headings.
|
|
- Use `N/A` for non-applicable sections.
|
|
- Include verification commands in the PR details.
|
|
- For `gh pr create` and `gh pr edit`, always write markdown body to a file and pass `--body-file`.
|
|
- Do not use multiline inline `--body`; backticks and shell expansion can corrupt content or trigger unintended commands.
|
|
- Recommended pattern:
|
|
- `cat > /tmp/pr_body.md <<'EOF'`
|
|
- `...markdown...`
|
|
- `EOF`
|
|
- `gh pr create ... --body-file /tmp/pr_body.md`
|
|
|
|
## CI Alignment
|
|
|
|
When changing CI-sensitive behavior, keep local validation aligned with
|
|
`.github/workflows/ci.yml`. Read the workflow file directly for the current
|
|
gate steps — do not rely on (or add) a copied command list here; copies go
|
|
stale. `make pre-pr` is the local equivalent of the main gate.
|