Skip to content

Commit e28c439

Browse files
committed
repo: align with current upstream repo-template contract
timestamp: 2026-04-12 09-26-39 KST changes: - replace governed repo policy text with the current upstream wording where applicable - keep Hwping-specific local divergence sections for macOS fork policy, mydocs routing, and upstream-intake - update local and remote commit-provenance enforcement to the current upstream schema - keep the Hwping-specific `project: hwping` validator rule and document it explicitly rationale: - keep this adopted repo aligned with the current repo-template contract without losing Hwping-specific workflow and product boundaries checks: - git diff --check - diff -u <(awk 'BEGIN{p=1} /^## Local Divergence$/{p=0} p' REPO.md) /Users/yeowool/Documents/repo-template/scaffold/REPO.md - diff -u <(awk 'BEGIN{p=1} /^## Local Divergence$/{p=0} p' AGENTS.md) /Users/yeowool/Documents/repo-template/scaffold/AGENTS.md - diff -u skills/README.md /Users/yeowool/Documents/repo-template/scaffold/skills/README.md - diff -u <(awk 'BEGIN{p=1} /^## Local Divergence$/{p=0} p' skills/repo-orchestrator/SKILL.md) /Users/yeowool/Documents/repo-template/scaffold/skills/repo-orchestrator/SKILL.md - diff -u .githooks/commit-msg /Users/yeowool/Documents/repo-template/.githooks/commit-msg - diff -u scripts/check-commit-range.sh /Users/yeowool/Documents/repo-template/scripts/check-commit-range.sh - git config --get core.hooksPath notes: - Hwping keeps the local `project:` trailer pin in `scripts/check-commit-standards.sh` project: hwping agent: codex role: worker commit: LOG-20260412-092639-codex
1 parent 930bfa7 commit e28c439

8 files changed

Lines changed: 186 additions & 126 deletions

File tree

.github/workflows/commit-standards.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
name: Commit Standards
22

33
on:
4-
push:
5-
branches: [main, devel]
64
pull_request:
7-
branches: [main, devel]
5+
push:
86

97
jobs:
108
commit-standards:

AGENTS.md

Lines changed: 50 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,52 @@
1-
# Hwping Agent Guide
1+
# Agent Instructions
22

3-
Hwping is a macOS-focused downstream fork of upstream `rhwp`.
3+
This repo uses repo-template.
44

5-
Use this file as the repo-root entrypoint for agent behavior. The canonical operating rules live in `REPO.md`.
5+
Treat `AGENTS.md` as the canonical editable agent-instructions file for the repo.
6+
It should enforce repo behavior while deferring canonical policy details to `REPO.md`.
67

78
## Read First
89

9-
- `README_EN.md` for the repo's scope and product boundary
10-
- `REPO.md` for routing, artifact rules, and commit provenance
11-
- `SPEC.md`, `STATUS.md`, `PLANS.md`, and `INBOX.md` for current project truth
10+
- `REPO.md`
11+
- `SPEC.md`
12+
- `STATUS.md`
13+
- `PLANS.md`
14+
- `INBOX.md`
1215
- `skills/README.md`
13-
- the local `README.md` or template for any surface you are about to edit
1416

1517
Before running a repeatable repo workflow, read the relevant `skills/<name>/SKILL.md`. Treat skills as repo-native procedures even when the agent runtime does not auto-load them.
1618

17-
## Hwping Priorities
19+
When writing into an artifact directory, read that directory's `README.md` first. If it includes a prescriptive shape, follow it. If it is intentionally lightweight, keep the output lightweight too.
1820

19-
- Keep the shared HWP/HWPX engine syncable with upstream `rhwp`.
20-
- Keep the repo focused on the macOS product and the layers it actually needs.
21-
- Treat engine changes as upstreamable unless there is a concrete Hwping-only reason not to.
22-
- Keep AppKit, SwiftUI, Quick Look, Finder integration, and other Apple-platform behavior out of shared engine code such as `crates/rhwp/`.
23-
- Do not reintroduce removed web demo, npm, VS Code, or browser-only surfaces into the main tree.
24-
25-
## Documentation Rules
21+
## Operating Rules
2622

27-
- Use English for all new or rewritten repository documents.
28-
- Route truth and provenance through the repo-template surfaces instead of ad hoc notes.
23+
- Keep durable truth in repo files, not only in external tools.
24+
- Route work using the routing ladder in `REPO.md`.
25+
- Preserve the boundary between `SPEC.md`, `STATUS.md`, `PLANS.md`, `INBOX.md`, `research/`, `records/decisions/`, commit-backed execution history, and `upstream-intake/`.
26+
- Worker agents should prefer evidence, proposals, and compliant commit-backed execution records. The orchestrator or operator owns truth-doc updates unless the operator explicitly allows a different flow.
2927
- Treat `INBOX.md` as pressure, not a backlog. During inbox review, cluster capture and promote only survived triage.
3028
- Promote sparsely. Do not mirror one evolving thought into research, decisions, plans, spec, status, upstream records, and execution records.
31-
- Keep deeper shared detail in `mydocs/tech/`, `mydocs/troubleshootings/`, and `mydocs/manual/`.
32-
- Do not recreate `mydocs/hwping/`.
33-
- If a local guide defines section order, naming, provenance fields, or a canonical example, follow it.
29+
- If the repo tracks upstream on a cadence, use `upstream-intake/` instead of inventing a parallel workflow.
30+
- When creating artifacts or commits, follow the stable-ID and provenance rules in `REPO.md`.
31+
- Prefer the local `README.md` shape over ad hoc formatting when it defines one.
32+
- Your commit message must satisfy the local repo provenance check before the commit is allowed.
33+
- Your pushed commits must satisfy the same provenance rules remotely in CI.
3434
- Treat each committed change as a canonical execution record through `commit: LOG-*`.
3535
- Normal commits must use the structured body keys `timestamp:`, `changes:`, `rationale:`, and `checks:` with `notes:` optional.
3636

37-
## Artifact Enforcement
37+
## Enforcement
38+
39+
When you write or update repo artifacts, adherence to the repo's ruleset is required.
3840

41+
- Do not invent a new document shape when the repo already provides a canonical surface, directory `README.md`, or explicit template.
42+
- Do not collapse truth, plans, decisions, research, inbox capture, and execution history into one mixed artifact.
3943
- Do not promote exploratory debate into `SPEC.md`, `STATUS.md`, `PLANS.md`, or `records/decisions/` until there is a concise accepted outcome for that layer.
4044
- Do not turn an inbox review into a giant digest of every low-confidence idea. Report counts or clusters when full detail does not protect focus.
45+
- Do not write chatty transcripts where the repo expects normalized records.
4146
- If an artifact guide is intentionally lightweight, do not over-structure the document just to make it look uniform.
42-
- Do not put `LOG-*` ids inside `artifacts:`.
47+
- If the repo guidance and the requested output appear to conflict, follow the repo rules and explain the tension in the artifact or handoff.
4348
- Do not bypass commit provenance checks by omitting required trailers unless the commit is an explicit bootstrap or migration exception.
49+
- Do not put `LOG-*` ids inside `artifacts:`.
4450

4551
## Skills
4652

@@ -49,8 +55,27 @@ Before running a repeatable repo workflow, read the relevant `skills/<name>/SKIL
4955
- Keep them procedural.
5056
- Do not duplicate canonical repo policy inside them.
5157
- Use them to standardize repeatable tasks, escalation triggers, and output shape.
58+
## Local Divergence
59+
60+
### Hwping Priorities
61+
62+
- Keep the shared HWP/HWPX engine syncable with upstream `rhwp`.
63+
- Keep the repo focused on the macOS product and the layers it actually needs.
64+
- Treat engine changes as upstreamable unless there is a concrete Hwping-only reason not to.
65+
- Keep AppKit, SwiftUI, Quick Look, Finder integration, and other Apple-platform behavior out of shared engine code such as `crates/rhwp/`.
66+
- Do not reintroduce removed web demo, npm, VS Code, or browser-only surfaces into the main tree.
67+
68+
### Documentation Rules
69+
70+
- Use English for all new or rewritten repository documents.
71+
- Route truth and provenance through the repo-template surfaces instead of ad hoc notes.
72+
- Treat `INBOX.md` as pressure, not a backlog. During inbox review, cluster capture and promote only survived triage.
73+
- Promote sparsely. Do not mirror one evolving thought into research, decisions, plans, spec, status, upstream records, and execution records.
74+
- Keep deeper shared detail in `mydocs/tech/`, `mydocs/troubleshootings/`, and `mydocs/manual/`.
75+
- Do not recreate `mydocs/hwping/`.
76+
- If a local guide defines section order, naming, provenance fields, or a canonical example, follow it.
5277

53-
## Validation And Debugging
78+
### Validation And Debugging
5479

5580
Prefer local Rust tooling:
5681

@@ -75,10 +100,11 @@ Reference paths:
75100
- `mydocs/manual/dump_command.md`
76101
- `mydocs/manual/ir_diff_command.md`
77102

78-
## Commit Discipline
103+
### Commit Discipline
79104

80105
- New commits should carry the provenance trailers required by `REPO.md`.
81106
- Local hook and CI enforcement live in `.githooks/commit-msg` and `.github/workflows/commit-standards.yml`.
107+
- Local commit validation pins `project:` to `hwping`.
82108
- A normal commit may reference an existing updated artifact; it does not need a brand-new `LOG-*`.
83109
- Prefer appending to the current relevant `LOG-*` when the same workstream continues.
84110
- Do not bypass commit checks with ad hoc formatting or `--no-verify`.

0 commit comments

Comments
 (0)