Skip to content

docs: add workflow comparison section to README #80

@q-soriarty

Description

@q-soriarty

Problem

README targets Claude Code users specifically but doesn't explain how this Gitflow skill compares to other common git workflows. Users coming from trunk-based development, GitHub Flow, or squash-merge strategies may not understand the value proposition or trade-offs.

Expected behavior

Add a brief comparison section to README (or a separate COMPARISON.md linked from README) covering:

  • Gitflow vs GitHub Flow — when to use which, trade-offs
  • Conventional Commits vs free-form — why structured messages matter
  • Merge commits vs squash — why this skill enforces --no-ff merge commits
  • Issue-driven vs ad-hoc branching — traceability benefits

Keep it concise — a table or short paragraphs, not an essay. The goal is to help users make an informed decision about adopting this workflow.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions