Skip to content

docs: document rebase-before-push as soft recommendation - #49

Open
smartwatermelon wants to merge 1 commit into
mainfrom
claude/docs-rebase-before-push-48
Open

docs: document rebase-before-push as soft recommendation#49
smartwatermelon wants to merge 1 commit into
mainfrom
claude/docs-rebase-before-push-48

Conversation

@smartwatermelon

Copy link
Copy Markdown
Owner

Summary

  • Documents rebasing onto the latest base branch before pushing/updating a PR as a soft, non-blocking process habit — addresses the recurring "This branch is out-of-date with the base branch" GitHub banner.
  • Adds the guidance under the pre-push section of docs/WORKFLOW-DEEP-DIVE.md (since the pre-push hook doesn't currently check this) and a corresponding row in the Known Gaps & Limitations table.
  • Explicitly scoped as a habit, not a gate: no blocking pre-push check added, and the doc calls out when to skip it (branch already current, shared/collaborative branches, branches under active review).
  • Also reformats the file's Markdown tables with proper GFM alignment padding — the existing tables were failing markdownlint's MD060 rule even on main before this change touched them; fixing this was required to get a clean local pre-commit run.

Test plan

  • pre-commit (markdownlint) passes locally
  • Local pre-push review (adversarial-reviewer + codebase reviewer) both PASS
  • Manually verified the #known-gaps--limitations anchor link resolves correctly

Closes #48

https://claude.ai/code/session_019yrvtEbtQxBxDmZ4Fu9GrU

Fixes #48. GitHub's "branch out of date" banner is a recurring nuisance
signal that the pre-push routine doesn't include a rebase-onto-latest-base
step. Documents it as a habit (not an enforced/blocking check) in the
pre-push section and Known Gaps & Limitations table of WORKFLOW-DEEP-DIVE.md.

Also reformats the file's markdown tables with proper GFM alignment
padding to satisfy the markdownlint MD060 rule, which was failing on
pre-existing tables (reproduced on main) before this change touched them.

Claude-Session: https://claude.ai/code/session_019yrvtEbtQxBxDmZ4Fu9GrU
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rebase before pushing a PR branch to avoid GitHub's 'branch out of date' warning

1 participant