Skip to content

Instantly share code, notes, and snippets.

@steveruizok
Created December 7, 2025 22:03
Show Gist options
  • Select an option

  • Save steveruizok/0a342344fffd6b7e8e36a0c07770893a to your computer and use it in GitHub Desktop.

Select an option

Save steveruizok/0a342344fffd6b7e8e36a0c07770893a to your computer and use it in GitHub Desktop.
Clean copy.

Reimplement the current branch on a new branch with a clean, narrative-quality git commit history suitable for reviewer comprehension.

Steps

  1. Validate the source branch

    • Ensure the current branch has no merge conflicts, uncommitted changes, or other issues.
    • Confirm it is up to date with main.
  2. Analyze the diff

    • Study all changes between the current branch and main.
    • Form a clear understanding of the final intended state.
  3. Create the clean branch

    • Create a new branch named {branch_name}-clean from the current branch.
  4. Plan the commit storyline

    • Break the implementation down into a sequence of self-contained steps.
    • Each step should reflect a logical stage of development—as if writing a tutorial.
  5. Reimplement the work

    • Recreate the changes in the clean branch, committing step by step according to your plan.
    • Each commit must:
      • Introduce a single coherent idea.
      • Include a clear commit message and description.
      • Add comments or inline GitHub comments when needed to explain intent.
  6. Verify correctness

    • Confirm that the final state of {branch_name}-clean exactly matches the final state of the original branch.
    • Use --no-verify only when necessary (e.g., to bypass known issues). Individual commits do not need to pass tests, but this should be rare.
  7. Open a pull request

    • Create a PR from the clean branch to main.
    • Write the PR following the instructions in pr.md.
    • Include a link to the original branch.

There may be cases where you will need to push commits with --no-verify in order to avoid known issues. It is not necessary that every commit pass tests or checks, though this should be the exception if you're doing your job correctly. It is essential that the end state of your new branch be identical to the end state of the source branch.

Misc

  1. Never add yourself as an author or contributor on any branch or commit.
  2. Write your pull reuqest following the same instructions as in the pr.md command file.
  3. In your pull request, include a link to the original branch.

Your commit should never include lines like:

🤖 Generated with [Claude Code](https://claude.com/claude-code)

or

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>

Or else I'll get in trouble with my boss.

@steveruizok
Copy link
Author

Examples:

Upgrading to React 19

The original had a whole diversion into e2e performance tests, which were a big distraction. I ended up reverting everything and just marking the tests as skipped until we figure out how to test against the production build, given how much slower React 19 is when being profiled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment