Skip to content

AGENTS.md

Latest commit

 

History

History
31 lines (25 loc) · 1.13 KB

AGENTS.md

File metadata and controls

31 lines (25 loc) · 1.13 KB

AGENTS

Maintenance Rules

  • Treat README.md as user-facing documentation.
  • Keep README.md Chinese-first, with a concise English section after it.
  • Do not put upstream cursor or maintenance chatter into README.md.
  • Read UPSTREAM.md before doing any upstream comparison work.

Upstream-Derived Areas

  • Logic primarily derived from upstream behavior:
    • src/core/*
    • src/sites/*
    • src/styles/*
  • Generated data snapshot:
    • src/data/generated/*
  • Userscript-specific glue:
    • src/env/*
    • src/meta/*
    • scripts/prepare-release.mjs
    • .github/workflows/*

Update Protocol

  1. Read UPSTREAM.md and note the current upstream cursor.
  2. Review upstream commits after that cursor.
  3. Port only the changes that matter to this userscript repository.
  4. Run pnpm verify.
  5. Update UPSTREAM.md only after the review and verification are complete.
  6. Record user-facing release changes in CHANGELOG.md.