chore(quantecon): switch to merge-to-main development model#23
Merged
Conversation
Remove the integration-branch tooling (build.sh, features.txt) and rewrite the maintenance guide. Features now squash-merge directly into main; feature branches are preserved post-merge as upstream PR artifacts. This removes ~200 lines of bash and a class of "the integration branch is stale" failure modes. Projects install from main instead of the discontinued `quantecon` branch. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Documentation/tooling-only change that retires the throwaway quantecon integration branch in favor of squash-merging feature branches directly into this fork's main, while keeping the original feature branches alive as upstream PR artifacts.
Changes:
- Delete
quantecon/build.shandquantecon/features.txt(no longer needed under the merge-to-main model). - Rewrite
quantecon/README.mdto document the new workflow: branch fromupstream/main, PR intoQuantEcon/mystmd:main, squash-merge, preserve branch for upstream PR. - Update install instructions in the README to clone
--branch maininstead of--branch quantecon.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
quantecon/README.md |
Rewrites the maintenance guide to describe the squash-merge-to-main workflow and updates GitHub Actions install snippet to use main. |
quantecon/features.txt |
Removed; feature tracking is now done via live feature/* branches. |
quantecon/build.sh |
Removed; integration branch is no longer built. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…t README) Adds quantecon/.gitignore so PLAN docs, demo books, and other local experiments can live alongside the maintenance guide without risk of accidental commits. Only README.md and .gitignore itself are tracked. Co-Authored-By: Claude Opus 4.7 <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.
Summary
quantecon/build.sh,quantecon/features.txt)quantecon/README.mdfor the new workflow: features squash-merge intomain; feature branches are preserved post-merge as upstream PR artifactsmaininstead of the discontinuedquanteconintegration branchWhy
The previous model kept feature branches unmerged and built a throwaway
quanteconintegration branch viabuild.sh. That worked for one feature, but doesn't scale: stacked unmerged branches drift, rebase pain compounds, and projects have to track a custom tip nobody else uses.A merged branch is still upstreamable. Merging
feature/<name>into ourmaindoesn't alter the branch itself — when upstream is ready, we push the preserved branch and open a PR againstjupyter-book/mystmd:main. Same commits, same diff, same review experience.Net effect: ~200 lines of bash gone, simpler dev process, no integration-branch failure modes, upstream PR readiness preserved.
Sequencing
Land this PR first, then squash-merge the open feature PRs into
main:feature/myst-to-ipynbfeature/book-numberingBoth feature branches stay alive after merging for the eventual upstream PRs.
Test plan
quantecon/build.shandquantecon/features.txtare gone after mergegit clone --branch main+bun install && bun run buildstill works (no code changed, this should be a no-op)🤖 Generated with Claude Code