branch-guidelines

Enforce GitHub Flow branch naming and creation guidelines.

Updated Aug 6, 2023
One-click install
npx skills add https://github.com/k2bg-technology/k2bg-branding --skill branch-guidelines
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: branch-guidelines
Source: https://github.com/k2bg-technology/k2bg-branding/tree/main/.claude/skills/branch-guidelines
Command: npx skills add https://github.com/k2bg-technology/k2bg-branding --skill branch-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides clear, project-specific guidelines for creating and managing Git branches, ensuring consistency and maintainability in your development workflow.

Core Features & Use Cases

  • Branch Naming Conventions: Enforces a standardized format for feature, fix, release, and hotfix branches.
  • Workflow Adherence: Guides users on branching from main and keeping branches updated.
  • Use Case: When starting a new feature, consult this Skill to ensure your branch is named correctly (e.g., feature/123-add-login-api) and derived from the latest main branch.

Quick Start

Follow the branch naming convention for a new feature by creating a branch from main.

Frequently Asked Questions about branch-guidelines

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is the standard Git branch naming convention for feature and hotfix branches?

The standard Git branch naming convention uses prefixes like feature, fix, release, or hotfix, optionally followed by an issue number, such as feature/123-add-login-api, to maintain workflow consistency.

How do I create a new Git branch using GitHub Flow principles?

To create a new Git branch using GitHub Flow, you derive a work branch directly from the main branch. This ensures the main branch remains deployable while you integrate feature, fix, release, or hotfix changes separately.

When do I need a hotfix branch in my Git workflow?

You need a hotfix branch in your Git workflow when addressing critical issues in production. Derived from main, it allows you to urgently patch problems while maintaining the standardized branch naming convention for project consistency.

Does GitHub Flow require branching directly from main for all changes?

Yes, GitHub Flow requires branching directly from main for all changes to keep the main branch deployable. Whether creating a feature, fix, or release branch, you must derive it from the latest main branch.

What is the best way to manage Git branches for consistent development workflows?

The best way to manage Git branches for consistent workflows is to enforce project-specific guidelines based on GitHub Flow. This involves standardized naming for feature and hotfix branches and ensuring all changes derive from main.