diff --git a/docs/anchors/github-flow.adoc b/docs/anchors/github-flow.adoc new file mode 100644 index 0000000..79cb88d --- /dev/null +++ b/docs/anchors/github-flow.adoc @@ -0,0 +1,43 @@ += GitHub Flow +:categories: development-workflow +:roles: software-developer, devops-engineer, team-lead +:related: conventional-commits, semantic-versioning +:proponents: Scott Chacon +:tags: git, branching, pull-request, continuous-delivery, workflow, feature-branch, code-review, main-branch + +[%collapsible] +==== + +[discrete] +== *Core Concepts*: + +* A lightweight, branch-based workflow where `main` is always deployable +* Feature branches are short-lived, created from `main` for every change +* Pull Requests are the central collaboration mechanism — used for code review, discussion, and CI validation before merging +* Merging to `main` triggers immediate deployment (continuous delivery) +* Branch naming reflects the work: issue number or short descriptive slug + +Workflow steps:: +. Create a branch from `main` (named after the issue or feature) +. Commit changes with descriptive messages +. Open a Pull Request early for visibility and feedback +. Discuss, review, and iterate until the PR is approved +. Merge to `main` — `main` is always in a deployable state +. Deploy immediately after merge + +Key Proponent:: Scott Chacon ("GitHub Flow", 2011) + +[discrete] +== *When to Use*: + +* Teams practicing continuous delivery or continuous deployment +* Projects where `main` must always be production-ready +* Issue-driven or ticket-driven development workflows +* Agentic coding workflows where context brevity matters + +[discrete] +== *Related Anchors*: + +* <> +* <> +==== diff --git a/docs/anchors/github-flow.de.adoc b/docs/anchors/github-flow.de.adoc new file mode 100644 index 0000000..1c92dce --- /dev/null +++ b/docs/anchors/github-flow.de.adoc @@ -0,0 +1,43 @@ += GitHub Flow +:categories: development-workflow +:roles: software-developer, devops-engineer, team-lead +:related: conventional-commits, semantic-versioning +:proponents: Scott Chacon +:tags: git, branching, pull-request, continuous-delivery, workflow, feature-branch, code-review, main-branch + +[%collapsible] +==== + +[discrete] +== *Kernkonzepte*: + +* Ein schlanker, branch-basierter Workflow, bei dem `main` immer auslieferbar ist +* Feature-Branches sind kurzlebig und werden für jede Änderung aus `main` erstellt +* Pull Requests sind der zentrale Kollaborationsmechanismus — für Code-Review, Diskussion und CI-Validierung vor dem Mergen +* Das Mergen in `main` löst sofortige Auslieferung aus (Continuous Delivery) +* Branch-Namen spiegeln die Arbeit wider: Issue-Nummer oder kurzer beschreibender Slug + +Workflow-Schritte:: +. Branch von `main` erstellen (benannt nach Issue oder Feature) +. Änderungen mit aussagekräftigen Nachrichten committen +. Pull Request frühzeitig öffnen für Transparenz und Feedback +. Diskutieren, reviewen und iterieren bis der PR genehmigt ist +. In `main` mergen — `main` ist immer auslieferbar +. Sofort nach dem Merge deployen + +Schlüsselvertreter:: Scott Chacon ("GitHub Flow", 2011) + +[discrete] +== *Wann zu verwenden*: + +* Teams, die Continuous Delivery oder Continuous Deployment praktizieren +* Projekte, bei denen `main` stets produktionsbereit sein muss +* Issue-getriebene oder Ticket-getriebene Entwicklungsworkflows +* Agentische Coding-Workflows, bei denen Kontextkürze wichtig ist + +[discrete] +== *Verwandte Anker*: + +* <> +* <> +==== diff --git a/skill/semantic-anchor-translator/references/catalog.md b/skill/semantic-anchor-translator/references/catalog.md index 3cdfd39..7cc3838 100644 --- a/skill/semantic-anchor-translator/references/catalog.md +++ b/skill/semantic-anchor-translator/references/catalog.md @@ -252,6 +252,10 @@ Source: https://github.com/LLM-Coding/Semantic-Anchors ## Development Workflow +### GitHub Flow +- **Proponents:** Scott Chacon +- **Core:** Branch-based workflow — short-lived feature branches, Pull Request reviews, `main` always deployable, merge triggers immediate deployment + ### Conventional Commits - **Proponents:** Benjamin E. Coe, James J. Womack, Steve Mao - **Core:** Structured commit messages: type(scope): description diff --git a/website/public/data/anchors.json b/website/public/data/anchors.json index 4e0921f..3ec14b5 100644 --- a/website/public/data/anchors.json +++ b/website/public/data/anchors.json @@ -523,6 +523,36 @@ ], "filePath": "docs/anchors/gherkin.adoc" }, + { + "id": "github-flow", + "title": "GitHub Flow", + "categories": [ + "development-workflow" + ], + "roles": [ + "software-developer", + "devops-engineer", + "team-lead" + ], + "related": [ + "conventional-commits", + "semantic-versioning" + ], + "proponents": [ + "Scott Chacon" + ], + "tags": [ + "git", + "branching", + "pull-request", + "continuous-delivery", + "workflow", + "feature-branch", + "code-review", + "main-branch" + ], + "filePath": "docs/anchors/github-flow.adoc" + }, { "id": "gof-abstract-factory-pattern", "title": "GoF-Abstract Factory Pattern",