docs: record the git flow and squash-merge consequences - #63
Merged
Conversation
Squash-only merges mean a merged branch stops being an ancestor of main, so working branches must be reset after merging or the next PR conflicts against everything. Test firmware comes from a tag on main.
georgesleen
force-pushed
the
docs/git-flow
branch
from
August 16, 2026 06:46
1cb4fac to
0ecbec6
Compare
sailbot-eleclead
previously approved these changes
Aug 16, 2026
Bulleted, terse. The Flashed section exists because the v0.1.0 notes first claimed boards were verified against the tag when they were verified against their working branches, which the merge had since changed.
sailbot-eleclead
previously approved these changes
Aug 16, 2026
The .ioc job checks peripherals only, not pins, clocks or DMA. Naming it "in sync" oversells it, so say so in the README instead. Also records that a board flashed from a working branch is not running the tag, with v0.1.0 as the worked example.
sailbot-eleclead
previously approved these changes
Aug 16, 2026
It compares declared peripherals against MX_*_Init calls. It does not check pins, clocks or DMA, so "in sync with generated code" claimed more than the job delivers.
sailbot-eleclead
approved these changes
Aug 16, 2026
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
2 participants
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.
Adds a short git flow section to the README.
The repository allows squash merges only. After a squash, the merged branch stops being an ancestor of
main, so git cannot tell thatmainalready contains the work. Anyone who keeps committing on a working branch after it merges will hit conflicts against everything on their next PR. That happened to all four module branches when #62 landed.Documents the flow, the
git reset --hard origin/mainstep after a merge, and why working branches should stay short-lived.Branch names are unchanged; "working branch" stays.