DOC: document multi-phase work and release procedure; add AGENTS.md - #941
Open
mmcky wants to merge 2 commits into
Open
DOC: document multi-phase work and release procedure; add AGENTS.md#941mmcky wants to merge 2 commits into
mmcky wants to merge 2 commits into
Conversation
Records the merge/release strategy agreed for campaign-style work such as the WASM browser-support project tracked in #925: umbrella issue + sub-issues under a milestone, trunk-based merging with no long-lived feature branches, main kept releasable after every merge, and an intermediate release as soon as a later phase depends on shipped fixes. The procedure lives in the canonical contributing guide (rendered on Read the Docs); AGENTS.md is a new tool-neutral entry point for AI coding agents that carries the quickstart plus repo conventions and points to the guide. It is written version- and count-free so it does not drift the way .github/copilot-instructions.md has. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
GitHub Copilot reads root AGENTS.md, so the Copilot-specific file is redundant, and it had drifted (Python 3.11-3.13 and 536 tests vs the current 3.12-3.14 matrix and 605 tests; flit install vs the guide's --symlink). The durable hints (env creation time, Numba JIT warm-up, the slow-test marker) move into AGENTS.md; nothing referenced the removed file. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates contributor-facing documentation to clarify how to run multi-phase, campaign-style work (tracked via umbrella issues + sub-issues + milestones) while keeping main continuously releasable, and adds a root-level entry point for AI coding agents that points to the canonical contributing guide.
Changes:
- Add a “Multi-phase projects and releases” section to the contributing guide describing tracking, incremental merging to
main, and when to cut intermediate releases. - Add
AGENTS.mdwith a tool-neutral quickstart and repository conventions for AI agents.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/source/contributing.rst | Documents the recommended GitHub tracking + incremental merge + release approach for multi-phase work. |
| AGENTS.md | Adds agent-oriented quickstart and workflow guidance, pointing back to the canonical contributing guide. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
coverage: 90.78%. remained the same — docs/multiphase-procedures into main |
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.
Merge after #938 — this PR documents conventions that one introduces (
testpaths = quantecon, theci/directory).Documents the merge and release procedure for multi-phase, campaign-style work, as discussed while reviewing #938. The WASM browser-support campaign (#925) is the reference example.
Two pieces:
docs/source/contributing.rst, rendered on Read the Docs): track campaigns as an umbrella issue + sub-issues under a milestone; merge tomainas you go rather than holding a long-lived feature branch (integration branches rot, bypass the required CI contexts configured formain, and workflows are onlyworkflow_dispatch-able from the default branch); keepmainreleasable after every merge; and cut an intermediate release as soon as a later phase depends on shipped fixes, treating the milestone as the release checklist.AGENTS.md— a tool-neutral entry point for AI coding agents carrying the quickstart (env, tests, lint), theci/directory convention from WASM: JupyterLite environment config and browser smoke suite #938 (CI-only assets, opt-in collection), and the working procedure above, pointing at the contributing guide rather than duplicating it. It is deliberately written without version numbers or test counts so it does not drift..github/copilot-instructions.md: GitHub Copilot reads rootAGENTS.md, so the Copilot-specific file is redundant, and it had drifted badly (it claimed Python 3.11–3.13 and 536 tests vs the current 3.12–3.14 matrix and 605 tests, and plainflit installvs the guide's--symlink). Its durable hints (env-creation time, Numba JIT warm-up, the slow-test marker) moved intoAGENTS.md; nothing referenced the removed file.Docs-only change;
rstverified with docutils locally and the Read the Docs preview will render the new section.🤖 Generated with Claude Code