Skip to content

docs: add workflow comparison section to README (#80)#84

Merged
q-soriarty merged 2 commits intodevelopfrom
docs/80-workflow-comparison
Mar 27, 2026
Merged

docs: add workflow comparison section to README (#80)#84
q-soriarty merged 2 commits intodevelopfrom
docs/80-workflow-comparison

Conversation

@q-soriarty
Copy link
Copy Markdown
Contributor

@q-soriarty q-soriarty commented Mar 27, 2026

Summary

  • Add "Why This Workflow?" section comparing Gitflow vs GitHub Flow vs Trunk-Based
  • Include comparison table (branches, releases, commits, merge strategy, traceability)
  • Add "When to use" and "When NOT to use" decision guides
  • Upgrade GitHub Actions: checkout v4→v5, github-script v7→v8 (Node.js 24 compatible)

Closes #80

Test plan

  • Comparison table covers Gitflow, GitHub Flow, and Trunk-Based
  • "When to use" and "When NOT to use" sections are present
  • Lint passes
  • CI runs without Node.js 20 deprecation warning

Compare Gitflow vs GitHub Flow vs Trunk-Based with a decision
guide for when to use (and not use) this workflow.
Update actions/checkout v4 → v5 and actions/github-script v7 → v8
to resolve Node.js 20 deprecation warning. Also update the
reference workflow in SKILL.md.
@q-soriarty q-soriarty merged commit 257ecfb into develop Mar 27, 2026
1 check passed
@q-soriarty q-soriarty deleted the docs/80-workflow-comparison branch March 27, 2026 23:09
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.

1 participant