git-workflow

Enforce standardized Git workflows with branch naming, conventional commits, and PR templates.

31|4|Updated Aug 21, 2024
One-click install
npx skills add https://github.com/oaknational/oak-ai-lesson-assistant --skill git-workflow-oaknational
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-workflow
Source: https://github.com/oaknational/oak-ai-lesson-assistant/tree/main/.claude/skills/git-workflow
Command: npx skills add https://github.com/oaknational/oak-ai-lesson-assistant --skill git-workflow-oaknational

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill codifies Oak's git conventions, making it faster and safer to create branches, write meaningful commit messages, and coordinate PRs with templates and checks.

Core Features & Use Cases

  • Branch Naming: Feature branches named like feat/AI-XXXX-description, bug fixes like fix/description, and chore/description.
  • Commit Messages: Conventional commits format (feat:, fix:, docs:, etc.) to keep history readable and automatable.
  • PR & CI Checks: Use PR templates and monitor CI checks to ensure code quality before merging.
  • Quality Gates: Before committing or creating a PR, verify formatting, linting, type checks, and tests pass.

Quick Start

Create a new feature branch named feat/AI-XXXX-description, commit with a conventional message like "feat: add feature X", push, and open a PR using the template. Then monitor CI checks and ensure they pass before merging.

Frequently Asked Questions about git-workflow

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

FAQPage Schema
How do I set up standardized branch naming conventions for my development team?

Branch naming conventions organize feature work and bug fixes using prefixes like feat/AI-XXXX-description for features, fix/description for bugs, and chore/description for maintenance. This Skill enforces these patterns across your team, making branch history readable and enabling automated CI checks to validate branch names before code is pushed.

What's the best way to write commit messages that stay consistent across a team?

Conventional commits format (feat:, fix:, docs:, etc.) keeps commit history readable and automatable for release notes and versioning. This Skill codifies that standard, so every team member writes meaningful messages like 'feat: add feature X' or 'fix: resolve bug Y', making the project history traceable and actionable.

How do I enforce code quality checks before merging pull requests?

PR templates and CI checks catch formatting, linting, type errors, and test failures before code reaches main. This Skill monitors CI status and validates that branches follow naming conventions and commits match conventional format, ensuring only quality code passes through code review and deployment pipelines.

Can I use this workflow for feature branches, bug fixes, and chores all at once?

Yes. This Skill applies standardized Git workflows across all work types—features, bug fixes, chores, and code reviews—with branch prefixes and commit conventions tailored to each. It works across development, testing, and deployment stages, so the entire team follows one coherent process.

What happens if my commit message or branch name doesn't follow the standard?

Quality gates verify formatting and naming conventions before commits and PRs are created. If a branch or message violates the standard, the check fails and shows what correction is needed, preventing non-standard work from entering the pipeline and keeping history clean.