Skip to content
This repository was archived by the owner on Feb 21, 2023. It is now read-only.
This repository was archived by the owner on Feb 21, 2023. It is now read-only.

Document what a good commit series looks like (a story) #55

@mcomella

Description

@mcomella

A wrote this at one point:

While you can use commits for yourself, a commit series in a pull request is for the reviewer (or the bisector): they should tell a story which helps the reviewer understand the code. A good story should be modular and shouldn't go back on what it has already said.

For example, a good story says "I put down this building block and this building block so I can place another building block on top of both them, which makes it easier to fit this building block, and the final building block on top of that, which completes the issue." However, this story feels like, "I put down this building block, then picked it up and moved it back here, then added another building block, which I moved forward an inch, ..."

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions