Skip to content

docs(contributing): add branch purposes, flow diagram, and toc updates#241

Merged
michaeljymsgutierrez merged 1 commit into
developfrom
docs/update-contributing-branch-flow
Jun 28, 2026
Merged

docs(contributing): add branch purposes, flow diagram, and toc updates#241
michaeljymsgutierrez merged 1 commit into
developfrom
docs/update-contributing-branch-flow

Conversation

@michaeljymsgutierrez

Copy link
Copy Markdown
Owner

Description

Expands CONTRIBUTING.md with a Branch Purposes reference table, a Branch Flow section with a Mermaid diagram, and a Table of Contents update. Contributors now have a clear visual guide for the repository's branching strategy across the Developing, Releasing, and Stabilizing phases.

Github Issue: N/A

Changes

  • CONTRIBUTING.md - added Branch Purposes table documenting the four permanent staple branches (main, release, develop, canary) and a Branch Flow section with a Mermaid diagram illustrating the three-phase flow (Developing, Releasing, Stabilizing)
  • CONTRIBUTING.md - updated Table of Contents to include the two new sections
  • CONTRIBUTING.md - tightened Development Workflow steps to align with the documented branch flow

Screenshots/Images

N/A

How Has This Been Tested?

  • Manual testing: Reviewed the rendered Mermaid diagram and verified all TOC anchor links resolve correctly.

Checklist

  • Code follows the project's coding standards and best practices.
  • Existing tests pass.
  • Documentation is updated to reflect changes.
  • The PR is assigned to the correct reviewers.

Reviewer Guidance

  • Open CONTRIBUTING.md and verify the Branch Purposes table accurately describes each staple branch
  • Verify the Mermaid diagram renders correctly and reflects the correct branch flow (work branches merge to develop, develop checks out to release/vX.X.X, release/vX.X.X merges to release, then release rebases to main, canary, and develop)
  • Verify all Table of Contents links resolve to their respective sections

@michaeljymsgutierrez michaeljymsgutierrez self-assigned this Jun 28, 2026
@vercel

vercel Bot commented Jun 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
arm-js-library-demo Ready Ready Preview, Comment Jun 28, 2026 6:26pm

@michaeljymsgutierrez michaeljymsgutierrez added the docs Documentation additions or improvements label Jun 28, 2026
@michaeljymsgutierrez michaeljymsgutierrez merged commit 81e929f into develop Jun 28, 2026
3 checks passed
@michaeljymsgutierrez michaeljymsgutierrez deleted the docs/update-contributing-branch-flow branch June 28, 2026 18:27
michaeljymsgutierrez added a commit that referenced this pull request Jun 30, 2026
- [c099dd9][michaeljymsgutierrez]: Updated release version from v2.9.0 to v2.9.1 - 2026-07-01 02:27:36
- [9ca0c99][Chael Gutierrez]: fix(deploy): rename release branch prefix to releases to avoid ref collision (#245) - 2026-07-01 02:26:00
- [f823754][Chael Gutierrez]: chore(deps): fix dependabot security alerts - upgrade vite, vitest, form-data and markdown-it (#244) - 2026-07-01 01:55:56
- [2fcec47][Chael Gutierrez]: chore(deploy): add pre-flight checks, dry-run mode, canary sync, path safety and fail-fast (#243) - 2026-07-01 01:36:47
- [8cf2be1][Chael Gutierrez]: test(units): improve test structure and expand coverage across all unit modules (#242) - 2026-07-01 00:38:33
- [81e929f][Chael Gutierrez]: docs(contributing): add branch purposes, flow diagram, and toc updates (#241) - 2026-06-29 02:27:20
- [9e02459][Chael Gutierrez]: docs(contributing): add CONTRIBUTING.md and link from README (#240) - 2026-06-29 02:07:47
- [b8e9297][Chael Gutierrez]: chore(deps): upgrade production dependencies (#239) - 2026-06-24 02:57:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation additions or improvements

Projects

Development

Successfully merging this pull request may close these issues.

1 participant