dev: .dev/ becomes .qe/dev/ — one QuantEcon folder per repository, no scratch in the tree - #314
Merged
Merged
Conversation
… scratch in the tree The notes convention moves inside .qe/, the repository's QuantEcon folder, flat at the root: README.md (the folder's contract), project.yml (tracker #257, registry slug engine-v027, programme translation) and dev/ as the only sub-folder. dev/ runs as a distillation record — log/ and decisions/ raw and append-only, the four pages rewritten in place — and is scoped to this repository. scratch/ is removed: nothing under .qe/ is git-ignored; working files live outside the tree. Pointers updated in AGENTS.md, .gitignore, check-dev-refs.mjs, ci.yml, the living notes and the code comments and reports that cite decision records. Raw entries keep their historical .dev/ mentions unedited. Two decision records filed (D-2026-09-21-notes-move-to-qe-dev, D-2026-09-21-no-scratch-in-tree); the two 2026-07-05 records carry the supersession note. Discussion: QuantEcon/qeps#39. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X9svovk2iK73syYQ82Fj3J
mmcky
added a commit
that referenced
this pull request
Sep 21, 2026
refreshed, draft #314 noted Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
mmcky
added a commit
that referenced
this pull request
Sep 21, 2026
* chore: release v0.29.1 Patch: the Malayalam editor's round-3 answers (#315) — ml rules 27 → 28, glossary v0.7.0; corrects the -ഉം comma rule v0.29.0 shipped. No source change in this commit; dist-action/ rebuilds byte-identical. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * dev: STATE.md verified 2026-09-21 — downstream workflow PRs merged, #289 refreshed, draft #314 noted Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
mmcky
marked this pull request as ready for review
September 23, 2026 03:41
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The changes are a consistent repository-structure migration with only minor documentation wording nits identified.
Review effort: Lite
Findings: 2
Open (2)
What changed in this PR
This PR relocates the repository’s QuantEcon project-management overlay from .dev/ to .qe/dev/, formalizing .qe/ as the single “QuantEcon folder” per repo (notes, decisions, logs, and declared project facts) and removing any in-repo scratch location.
Changes:
- Move/rename the notes convention to
.qe/dev/and update cross-references across docs, experiments, reports, scripts, and skill docs. - Add
.qe/README.md(folder contract) and.qe/project.yml(tracker/registry/programme declared facts). - Remove in-tree scratch expectations (update
.gitignore,AGENTS.md, and reference-check tooling/CI wiring).
| File | Description |
|---|---|
| src/language-config.ts | Update decision-record path references from .dev/ to .qe/dev/. |
| scripts/glossary/lib.mjs | Update decision-record path reference from .dev/ to .qe/dev/. |
| REVIEW-FABLE5-2026-07-15.md | Update .dev/ links and references to .qe/dev/. |
| experiments/thinking-sonnet5/REPORT.md | Update decision-record path reference to .qe/dev/. |
| experiments/thinking-sonnet5/PLAN.md | Update decision-record link target to .qe/dev/decisions/. |
| experiments/ml-benchmark/REPORT.md | Update .dev/FUTURE.md reference to .qe/dev/FUTURE.md. |
| experiments/ml-benchmark/DISPOSITIONS.md | Update .dev/decisions/ reference to .qe/dev/decisions/. |
| experiments/fr-glossary-programming/REPORT.md | Update decision-record path reference to .qe/dev/. |
| docs/projects/README.md | Update ARCHITECTURE link to new .qe/dev/ location. |
| dist-action/index.js | Rebuilt bundle to carry updated comment references for .qe/dev/ paths. |
| check-dev-refs.mjs | Switch reference scan root from .dev/ to .qe/; remove scratch carve-out. |
| AGENTS.md | Update notes location to .qe/dev/ and replace in-repo scratch guidance with external temp-dir guidance. |
| .qe/README.md | Add .qe/ contract describing purpose, boundary test, and lifecycle rules. |
| .qe/project.yml | Add declared project facts (tracker, registry slug, programme) for qe skills. |
| .qe/dev/STATE.md | Update log-path reference and .qe/dev/ wording. |
| .qe/dev/README.md | New dev/ notes README under .qe/ describing layout, lifecycle, and rules. |
| .qe/dev/PLAN.md | Update .dev/ references to .qe/dev/ and related pointers. |
| .qe/dev/log/2026-09-21-qe-migration.md | Add log entry documenting .dev→.qe/dev migration and scratch removal. |
| .qe/dev/log/2026-09-18-ml-round3.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-09-14-jb2-sync-fallout.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-09-03-ml-round2-answers.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-11-w0-sfix-batch.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-11-w0-closeout.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-11-init-trailing-newline.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-11-116-trailing-newline.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-10-issues-to-file.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-10-issue-review-workplan.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-05-writeconfig-merge.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-05-engine-ref.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-08-04-v0250-release.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-26-210-deletion-review.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-26-192-resync-trust-gate.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-wave1-complete.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-k-docs-truth.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-j-dead-input.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-i-dead-code.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-h-fail-closed.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-g-retry-usage.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-f-cheap-correctness.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-e-contracts.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-d-canonical-workflow.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-c-failure-optional.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-b-init-parity.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-24-pr-a-guardrails.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-16-dupcomment.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-15-f5rev.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-14-state-refresh.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/log/2026-07-05-65a4.md | Add session log under new .qe/dev/log/ location. |
| .qe/dev/FUTURE.md | Move FUTURE doc under .qe/dev/. |
| .qe/dev/ARCHITECTURE.md | Move ARCHITECTURE doc under .qe/dev/. |
| .qe/dev/decisions/D-2026-09-21-notes-move-to-qe-dev.md | New decision record for .dev→.qe/dev relocation. |
| .qe/dev/decisions/D-2026-09-21-no-scratch-in-tree.md | New decision record removing in-tree scratch convention. |
| .qe/dev/decisions/D-2026-09-18-ml-further-reading-lists-stay-english.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-09-03-ml-all-exercise-content-stays-english.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-09-01-ml-exercise-statements-stay-english.md | Move decision record under .qe/dev/decisions/ (with supersession note). |
| .qe/dev/decisions/D-2026-08-17-ml-math-heavy-sections-stay-english.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-08-11-bot-identity-machine-user.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-08-10-sync-does-not-first-translate.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-08-10-partial-sync-pr-ships-annotated.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-07-26-resync-trust-gate-association-set.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-07-24-tech-debt-audit-boundaries.md | Move decision record under .qe/dev/decisions/ and update internal references. |
| .qe/dev/decisions/D-2026-07-16-single-review-comment.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-07-15-sonnet5-validated.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-07-14-thinking-off-sonnet5.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-07-14-opus-for-bulk-seed.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-07-05-scratch-moves-to-dev-scratch.md | Annotate old decision with supersession note and relocate under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-07-05-adopt-dev-notes-convention.md | Annotate old decision with amendment note and relocate under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-06-01-malayalam-keep-english-policy.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-04-01-rebase-on-merge.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-03-06-cli-rename-translate.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-03-05-whole-file-backward-eval.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-03-04-ink-over-rich-cli.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2026-03-01-heading-maps-in-frontmatter.md | Move decision record under .qe/dev/decisions/. |
| .qe/dev/decisions/D-2025-10-01-accept-llm-translation-improvements.md | Move decision record under .qe/dev/decisions/. |
| .gitignore | Remove .dev/scratch ignores; document “no scratch in tree” rule and keep legacy ignores. |
| .github/workflows/ci.yml | Update CI ignore path from .dev/** to .qe/**; rename check step to “.qe references”. |
| .dev/README.md | Remove old .dev/ README (notes now live under .qe/dev/). |
| .dev/scratch/.gitkeep | Remove legacy .dev/scratch placeholder as scratch is no longer in-tree. |
| .claude/skills/glossary-review/SKILL.md | Update skill documentation to point to .qe/dev/decisions/ instead of .dev/decisions/. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Directory-rename detection moved the six .dev/ files main added since the branch point (two decision records, three log entries, the #319 arm references) into .qe/dev/. Conflicts resolved: - .qe/dev/STATE.md: main's re-verified page (#330), with its one .dev/ path mention updated and the #314 In-flight bullet replaced by a Recently-landed entry for the move itself. - src/language-config.ts: main's ml rules (#315/#317) with the four decision-record path comments pointed at .qe/dev/decisions/. - dist-action/index.js: rebuilt; differs from main only by those comments. Also carried through: rate-check.sh (#323, merged after this branch) wrote its logs to .dev/scratch/rate-check/, which would recreate an in-tree scratch folder that is no longer git-ignored. Logs now go to ${TMPDIR:-/tmp}/action-translation-rate-check/<stamp>/ per D-2026-09-21-no-scratch-in-tree; its README line updated to match. npm test 1590/1590, lint and format:check clean, check-dev-refs: 168 .qe/ references resolve. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…eference Reword the two comments that said .qe-only PRs never need the reference check: source changes are what usually invalidate a .qe/ reference, but a notes-only PR can still add a broken or mistyped one, so run `npm run check-dev-refs` before merging one. Raised by Copilot review. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The pilot's notes convention moves inside
.qe/, the repository's QuantEcon folder, per the rulings of 2026-09-21 now drafted as QEP-7 (QuantEcon/qeps#40, from the discussion at QuantEcon/qeps#39). This repository stays the pilot; it is the first field test of the draft's folder.What changes
git mv .dev .qe/dev— the convention itself is unchanged insidedev/. Raw entries underlog/anddecisions/are unedited and keep their historical.dev/mentions; the living pages (STATE.md,PLAN.md,FUTURE.md,ARCHITECTURE.md) and the movedREADME.mdare updated for the new location and describedev/as a distillation record: raw append-only, distilled pages rewritten in place, a tidy pass that promotes upward, scoped to this repository only..qe/README.md— the folder's contract (each root file's writer and lifecycle, the boundary test, the public-content rule) — and.qe/project.yml(tracker Work plan — 2026-08-10 backlog review: all 67 open issues triaged, fix-status verified against v0.25.0 (supersedes #94, #198) #257, registry slugengine-v027, programmetranslation), which theqeworkplan skills read first when they look for the tracker.scratch/is removed with its.gitkeepand.gitignorelines: nothing under.qe/is git-ignored; working files live outside the tree. Theghand commit-message conventions inAGENTS.mdwrite to a temporary directory instead.AGENTS.md(the project-notes section now also states the one-register rule: the tracker holds the state, STATE.md keeps to orientation and the resume checklist),.github/workflows/ci.yml(.qe/**),check-dev-refs.mjs(scans.qe/), the repo-local skill, and the code comments and reports that cite decision records.D-2026-09-21-notes-move-to-qe-devandD-2026-09-21-no-scratch-in-tree— and the two 2026-07-05 records carry the supersession note at the top, which is the one edit the convention permits. A session log entry records the move.dist-action/index.jsrebuilt: the only source change is four comment lines insrc/language-config.tsthat cite decision records by path, and the bundle carries comments.Not in this PR
STATE.md is untrimmed. Its In flight section restates tracker #257, and the two disagree on W1's target release (v0.30.0 against v0.28.0); bringing it to the new rule is the next tidy pass, not this move, and the log entry says so.
Checks
npm run lintclean at--max-warnings 0;npm test: 67 suites, 1,584 tests passed;npm run buildrebuilt the bundle (8 changed lines, all comments);npm run check-dev-refs: 168 references resolve. No CHANGELOG entry: nothing user-visible changes.🤖 Generated with Claude Code
https://claude.ai/code/session_01X9svovk2iK73syYQ82Fj3J
Generated by Claude Code
Update 2026-09-23 — merged with
mainmainmerged in (350d030, 11 commits: v0.29.1–v0.29.3 and #330). Directory-rename detection moved the six.dev/filesmainhad added since the branch point into.qe/dev/. Resolved:.qe/dev/STATE.mdtakes #330's re-verified page (so the Not in this PR note above is settled — the page is trimmed and W1 reads v0.30.0 in both places), with the #314 bullet turned into a Recently-landed entry for the move;src/language-config.tstakesmain's ml rules with the four decision-record path comments on.qe/dev/decisions/;dist-action/index.jsrebuilt (differs frommainonly by those comments).One semantic fix carried through:
rate-check.sh(#323, merged after this branch) wrote its logs to.dev/scratch/rate-check/, which would recreate an in-tree scratch folder that is no longer git-ignored. Its logs now go to${TMPDIR:-/tmp}/action-translation-rate-check/<stamp>/, perD-2026-09-21-no-scratch-in-tree.npm test1590/1590, lint andformat:checkclean,check-dev-refs: 168.qe/references resolve.