Skip to content

docs(branching): update branching strategy to use dev as default branch#11

Open
jumalaw98 wants to merge 2 commits intomainfrom
docs
Open

docs(branching): update branching strategy to use dev as default branch#11
jumalaw98 wants to merge 2 commits intomainfrom
docs

Conversation

@jumalaw98
Copy link
Contributor

@jumalaw98 jumalaw98 commented Mar 16, 2026

Summary

Brief description of what this PR does.

Changes

  • Change base branch from main to dev for feature branch creation and pull requests
  • Add upstream remote setup instructions for syncing with main repo
  • Introduce two-branch integration model: main for production, dev for staging and PRs
  • Define branch roles, merge targets, and naming conventions emphasizing dev usage
  • Update CI gate and pipeline to target dev branch instead of main
  • Describe hotfix workflow branching from main with PRs to main and dev
  • Highlight rules forbidding direct pushes to main and dev branches
  • Add detailed contributor and maintainer workflows with branch sync processes
  • Update documentation to reflect dev as active development branch and main as stable release branch

Summary by cubic

Make dev the default branch and PR target; main is reserved for releases and hotfixes. Updated README, docs/PRD.md, and docs/SECURITY.md, and added a full docs/CONTRIBUTING.md outlining the dev-first workflow, CI gates, environments, release/hotfix steps, and deployment triggers.

  • Migration
    • Existing clones: add upstream, fetch, and switch to dev (checkout and pull latest).
    • New work: branch from dev; open PRs to dev only.
    • Hotfixes: branch from main; open PRs to both main and dev.
    • Maintainers: release via dev → main, then sync main back into dev.

Written for commit a0415ad. Summary will update on new commits.

@vercel
Copy link

vercel bot commented Mar 16, 2026

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

Project Deployment Actions Updated (UTC)
sytcolabs Ready Ready Preview, Comment Mar 16, 2026 8:34am

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 4 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/CONTRIBUTING.md">

<violation number="1" location="docs/CONTRIBUTING.md:199">
P2: The contributor workflow pulls from `origin` (the fork), not `upstream`. Since the fork's `dev` isn't automatically kept in sync, `git pull origin dev` may fetch stale code. Consider changing the workflow to sync from upstream, e.g.:

  1. Branch off dev git fetch upstream
    git checkout dev && git rebase upstream/dev
    git checkout -b feat/your-feature
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@jumalaw98 jumalaw98 requested a review from Oukomondi March 16, 2026 07:51
@Oukomondi
Copy link
Collaborator

Looks good.

@Oukomondi Oukomondi closed this Mar 16, 2026
@Oukomondi Oukomondi reopened this Mar 16, 2026
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.

2 participants