Skip to content

Add custom branch workflow docs and ignore local recovery bundles - #267

Open
UcnacDx2 wants to merge 1 commit into
mainfrom
codex/research-best-practices-for-branch-decoupling
Open

Add custom branch workflow docs and ignore local recovery bundles#267
UcnacDx2 wants to merge 1 commit into
mainfrom
codex/research-best-practices-for-branch-decoupling

Conversation

@UcnacDx2

Copy link
Copy Markdown
Owner

Motivation

  • Document the repository's custom branch-splitting workflow and provide a recoverable snapshot and topic-branch map to make future upstream updates and replaying changes safer.
  • Prevent local recovery bundles from being accidentally committed by ignoring the .backup/ directory.

Description

  • Add docs/custom-branch-workflow.md describing the protection of the original work branch, the topic-oriented refs, a branch map of current topic anchors, recovery snapshot guidance, and recommended update/replay steps.
  • Update .gitignore to add .backup/ and fix a trailing-newline inconsistency for test.dart so local recovery bundles are excluded from commits.
  • Record notes in the new docs about the current local upstream anchor and constraints when full upstream fetch access is unavailable.

Testing

  • No automated tests were run for these documentation and ignore-list changes.

Codex Task

Copilot AI review requested due to automatic review settings June 12, 2026 07:42
@UcnacDx2

Copy link
Copy Markdown
Owner Author

CI Check 失败
工作流在执行过程中遇到错误。

点击展开错误详情 ``` Resolving dependencies... Could not find a file named "pubspec.yaml" in https://github.com/bggRGjQaUbCoE/flutter_file_picker.git 4c03c3413a915fa82f58d4591bfe3b62709a6edf. Failed to update packages.
</details>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds repository documentation for a custom branch-splitting workflow (including recovery snapshots and a topic-branch map) and updates .gitignore to prevent committing local recovery bundles under .backup/.

Changes:

  • Add docs/custom-branch-workflow.md describing the protected work branch, recovery snapshot strategy, topic refs, and an update/replay procedure.
  • Update .gitignore to ignore .backup/ and normalize the test.dart ignore entry formatting.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/custom-branch-workflow.md New documentation covering branch split rationale, recovery points, topic branch map, and replay/update steps.
.gitignore Adds ignore rule for .backup/ and tidies the test.dart entry formatting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +70 to +74
```bash
git switch -c adapted/<upstream-version> base/upstream-main
```

3. Replay topics in dependency order. Prefer cherry-picking only the commits unique to each topic; use `git log base/local-official-snapshot..custom/<topic>` to inspect each range first.
Comment on lines +108 to +109
git switch -c split/<topic> base/upstream-main
git cherry-pick <commit-or-range-for-that-topic>
git cherry-pick <commit-or-range-for-that-topic>
```

Keep `work` as a protected historical branch, and do new development on `adapted/<version>` plus `custom/*` topic branches.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants