mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 10:59:59 +00:00
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1.4 KiB
1.4 KiB
Contribution Flow
This repository uses a strict fork-first workflow.
- You MUST NOT commit directly to
main. - You MUST do all work in your own fork.
- You MUST open Pull Requests from your fork back to the main repository.
Why this matters:
mainMUST stay stable.- Shared CI resources are limited.
- Broken experimental work MUST NOT run in the main repository.
Step-by-Step Flow
- Create or update your fork.
- Create a branch in your fork with the right prefix.
- Make one focused change at a time.
- Run the relevant local checks.
- Push the branch to your fork.
- Wait until the CI in your fork is green.
- Open a Pull Request.
- Address review feedback in your fork.
Branch Prefixes
You MUST use these prefixes for branch names:
| Prefix | When to use it | Example |
|---|---|---|
feature |
New functionality or improvements. | feature/add-matomo-integration |
fix |
Bugfixes and other corrective changes. | fix/login-redirect |
agent |
Changes to agent instruction files such as AGENTS.md or files in docs/agents/. |
agent/debugging-guidance |
documentation |
Pure documentation-only changes. | documentation/docker-guide |
The pull-request workflow validates the branch prefix against the touched file scope and fails the job when they do not match.
More information about the contribution workflow is available here.