[Sprint 5] docs: git-flow branching strategy documentation #267

Closed
opened 2026-01-28 19:16:07 +00:00 by lmiranda · 0 comments
Owner

Summary

Document the development -> staging -> main branch promotion flow for the git-flow plugin.

Implementation

Location: plugins/git-flow/docs/BRANCHING-STRATEGY.md (new file)

Content to include:

Branch Types

  • main - Production-ready releases only
  • staging - Pre-production testing (optional)
  • development - Active development, feature branches merge here
  • feat/*, fix/*, docs/*, etc. - Feature branches

Workflow Documentation

  1. Feature Development

    • Create feature branch from development
    • Naming: type/short-description (e.g., feat/user-auth)
    • PR to development when ready
  2. Release Promotion

    • developmentstaging (optional testing)
    • stagingmain (production release)
    • Tag releases on main
  3. Hotfix Handling

    • Create from main
    • Merge to both main and development
  4. PR Requirements

    • To development: 1 approval, passing tests
    • To staging: 1 approval, all checks pass
    • To main: Protected, require PR from staging/development

Diagrams

Include Mermaid diagrams showing:

  • Branch flow
  • PR merge patterns
  • Release cycle

Acceptance Criteria

  • Create plugins/git-flow/docs/BRANCHING-STRATEGY.md
  • Include Mermaid diagrams for visual clarity
  • Update plugins/git-flow/README.md to reference new doc
  • Add link in docs/COMMANDS-CHEATSHEET.md

Wiki Reference

Implementation: Change V5.2.0 (Sprint 5)

## Summary Document the `development -> staging -> main` branch promotion flow for the git-flow plugin. ## Implementation **Location:** `plugins/git-flow/docs/BRANCHING-STRATEGY.md` (new file) **Content to include:** ### Branch Types - `main` - Production-ready releases only - `staging` - Pre-production testing (optional) - `development` - Active development, feature branches merge here - `feat/*`, `fix/*`, `docs/*`, etc. - Feature branches ### Workflow Documentation 1. **Feature Development** - Create feature branch from `development` - Naming: `type/short-description` (e.g., `feat/user-auth`) - PR to `development` when ready 2. **Release Promotion** - `development` → `staging` (optional testing) - `staging` → `main` (production release) - Tag releases on `main` 3. **Hotfix Handling** - Create from `main` - Merge to both `main` and `development` 4. **PR Requirements** - To `development`: 1 approval, passing tests - To `staging`: 1 approval, all checks pass - To `main`: Protected, require PR from staging/development ### Diagrams Include Mermaid diagrams showing: - Branch flow - PR merge patterns - Release cycle ## Acceptance Criteria - [ ] Create `plugins/git-flow/docs/BRANCHING-STRATEGY.md` - [ ] Include Mermaid diagrams for visual clarity - [ ] Update `plugins/git-flow/README.md` to reference new doc - [ ] Add link in `docs/COMMANDS-CHEATSHEET.md` ## Wiki Reference Implementation: [Change V5.2.0 (Sprint 5)](https://gitea.hotserv.cloud/personal-projects/leo-claude-mktplace/wiki/Change-V5.2.0%3A-Plugin-Enhancements-%28Sprint-5-Documentation%29)
lmiranda added this to the Sprint 5 - Documentation milestone 2026-01-28 19:19:32 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: personal-projects/leo-claude-mktplace#267