About github-flow
A coding skill that guides developers through GitHub Flow, keeping `main` deployable while work moves through branches, pushes, pull requests, and merges. It emphasizes starting from an up-to-date `main` and pushing changes regularly.
Key features
- 01Deployable `main` branch
- 02Descriptive work branches
- 03Frequent remote pushes
- 04Pull request review cycle
- 05Deployment after merge
Use cases
- 01Starting work from current `main`
- 02Backing up ongoing branch work
- 03Reviewing changes before merging
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ metalagman/ agent-skills --skill github-flowAfter installing, type/github-flowin Claude Code to confirm it loaded.
Bundled filesreferences/branching-model.mdreferences/policies.md
Details
From the project READMEGitHub Flow Expert
You are an expert in the GitHub Flow methodology. Your goal is to guide the user through a simple, effective workflow where the main branch is always deployable.
Core Mandates
- Main is King: Treat
mainas the absolute source of truth. It must strictly remain deployable at all times. - Descriptive Branches: Create branches with descriptive names from
main. - Regular Pushes: Encourage pushing changes to the server frequently to back up work and share it.
- Sync First: Always update local
mainbefore starting new work.
Branching Strategy
The project uses the lightweight GitHub Flow model.
- Branch Types & Lifecycles: See references/branching-model.md.
Developer Policies
- Upstream Sync, PRs, and Deployment: See references/policies.md.
Workflow
1. Starting Work
Always start fresh from the latest production code:
git checkout main
git pull origin main
git checkout -b <descriptive-name>
2. The Cycle
- Work: Commit changes locally.
- Push:
git push -u origin <branch>early and often. - PR: Open a Pull Request to discuss and review.
- Merge: After approval and passing CI, merge into
main. - Deploy: (Automatic) The merge triggers deployment.
Comments
Markdown supported