Repository navigation
docs(readme): retire in favour of git-splice - #59
Conversation
The design of git-subtrees is flawed at its root, in `git subtree` itself: a subtree remote is an ordinary remote that the whole monorepo can be pushed to by mistake (#50), `git subtree split` gets slower as the monorepo's history grows (#30), and subtree merges don't fit a linear history. git-splice keeps the goal without these problems, so point users there. The old documentation stays available at v0.1.2.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Docstring Coverage |  |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
| Title check | |
The title clearly and concisely states that the README retires the project in favor of git-splice. This matches the main change. |
| Description check | |
The description directly explains the README retirement, the limitations of git subtree, the move to git-splice, and the availability of older documentation. |
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6a736f109d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## The old documentation | ||
|
|
||
| The last release is | ||
| [v0.1.2](https://github.com/roschaefer/git-subtrees/tree/v0.1.2). Its | ||
| README documents every command. |
There was a problem hiding this comment.
Replacing the README removes the #sync-states anchor, but retained documentation still links to it from walkthrough/README.md:41 and test/scenarios/README.md:5. Anyone following those links now lands on the retired-project notice rather than the promised state definitions, so these links should point to the archived v0.1.2 documentation or the old section should remain available.
Useful? React with 👍 / 👎.
1 participant
The design of git-subtrees is flawed at its root, in
git subtreeitself: a subtree remote is an ordinary remote that the whole monorepo
can be pushed to by mistake (#50),
git subtree splitgets slower asthe monorepo's history grows (#30), and subtree merges don't fit a
linear history. git-splice keeps the goal without these problems, so
point users there. The old documentation stays available at v0.1.2.