Skip to content

Commit 9d09cfb

Browse files
authored
Merge pull request #180 from LLM-Coding/copilot/add-github-flow-terminology
feat: Add GitHub Flow semantic anchor
2 parents 2ff6837 + f94d1ed commit 9d09cfb

File tree

4 files changed

+120
-0
lines changed

4 files changed

+120
-0
lines changed

docs/anchors/github-flow.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
= GitHub Flow
2+
:categories: development-workflow
3+
:roles: software-developer, devops-engineer, team-lead
4+
:related: conventional-commits, semantic-versioning
5+
:proponents: Scott Chacon
6+
:tags: git, branching, pull-request, continuous-delivery, workflow, feature-branch, code-review, main-branch
7+
8+
[%collapsible]
9+
====
10+
11+
[discrete]
12+
== *Core Concepts*:
13+
14+
* A lightweight, branch-based workflow where `main` is always deployable
15+
* Feature branches are short-lived, created from `main` for every change
16+
* Pull Requests are the central collaboration mechanism — used for code review, discussion, and CI validation before merging
17+
* Merging to `main` triggers immediate deployment (continuous delivery)
18+
* Branch naming reflects the work: issue number or short descriptive slug
19+
20+
Workflow steps::
21+
. Create a branch from `main` (named after the issue or feature)
22+
. Commit changes with descriptive messages
23+
. Open a Pull Request early for visibility and feedback
24+
. Discuss, review, and iterate until the PR is approved
25+
. Merge to `main` — `main` is always in a deployable state
26+
. Deploy immediately after merge
27+
28+
Key Proponent:: Scott Chacon ("GitHub Flow", 2011)
29+
30+
[discrete]
31+
== *When to Use*:
32+
33+
* Teams practicing continuous delivery or continuous deployment
34+
* Projects where `main` must always be production-ready
35+
* Issue-driven or ticket-driven development workflows
36+
* Agentic coding workflows where context brevity matters
37+
38+
[discrete]
39+
== *Related Anchors*:
40+
41+
* <<conventional-commits,Conventional Commits>>
42+
* <<semantic-versioning,Semantic Versioning (SemVer)>>
43+
====

docs/anchors/github-flow.de.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
= GitHub Flow
2+
:categories: development-workflow
3+
:roles: software-developer, devops-engineer, team-lead
4+
:related: conventional-commits, semantic-versioning
5+
:proponents: Scott Chacon
6+
:tags: git, branching, pull-request, continuous-delivery, workflow, feature-branch, code-review, main-branch
7+
8+
[%collapsible]
9+
====
10+
11+
[discrete]
12+
== *Kernkonzepte*:
13+
14+
* Ein schlanker, branch-basierter Workflow, bei dem `main` immer auslieferbar ist
15+
* Feature-Branches sind kurzlebig und werden für jede Änderung aus `main` erstellt
16+
* Pull Requests sind der zentrale Kollaborationsmechanismus — für Code-Review, Diskussion und CI-Validierung vor dem Mergen
17+
* Das Mergen in `main` löst sofortige Auslieferung aus (Continuous Delivery)
18+
* Branch-Namen spiegeln die Arbeit wider: Issue-Nummer oder kurzer beschreibender Slug
19+
20+
Workflow-Schritte::
21+
. Branch von `main` erstellen (benannt nach Issue oder Feature)
22+
. Änderungen mit aussagekräftigen Nachrichten committen
23+
. Pull Request frühzeitig öffnen für Transparenz und Feedback
24+
. Diskutieren, reviewen und iterieren bis der PR genehmigt ist
25+
. In `main` mergen — `main` ist immer auslieferbar
26+
. Sofort nach dem Merge deployen
27+
28+
Schlüsselvertreter:: Scott Chacon ("GitHub Flow", 2011)
29+
30+
[discrete]
31+
== *Wann zu verwenden*:
32+
33+
* Teams, die Continuous Delivery oder Continuous Deployment praktizieren
34+
* Projekte, bei denen `main` stets produktionsbereit sein muss
35+
* Issue-getriebene oder Ticket-getriebene Entwicklungsworkflows
36+
* Agentische Coding-Workflows, bei denen Kontextkürze wichtig ist
37+
38+
[discrete]
39+
== *Verwandte Anker*:
40+
41+
* <<conventional-commits,Conventional Commits>>
42+
* <<semantic-versioning,Semantic Versioning (SemVer)>>
43+
====

skill/semantic-anchor-translator/references/catalog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,10 @@ Source: https://github.com/LLM-Coding/Semantic-Anchors
261261

262262
## Development Workflow
263263

264+
### GitHub Flow
265+
- **Proponents:** Scott Chacon
266+
- **Core:** Branch-based workflow — short-lived feature branches, Pull Request reviews, `main` always deployable, merge triggers immediate deployment
267+
264268
### Conventional Commits
265269
- **Proponents:** Benjamin E. Coe, James J. Womack, Steve Mao
266270
- **Core:** Structured commit messages: type(scope): description

website/public/data/anchors.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,36 @@
506506
"filePath": "docs/anchors/gherkin.adoc",
507507
"tier": 3
508508
},
509+
{
510+
"id": "github-flow",
511+
"title": "GitHub Flow",
512+
"categories": [
513+
"development-workflow"
514+
],
515+
"roles": [
516+
"software-developer",
517+
"devops-engineer",
518+
"team-lead"
519+
],
520+
"related": [
521+
"conventional-commits",
522+
"semantic-versioning"
523+
],
524+
"proponents": [
525+
"Scott Chacon"
526+
],
527+
"tags": [
528+
"git",
529+
"branching",
530+
"pull-request",
531+
"continuous-delivery",
532+
"workflow",
533+
"feature-branch",
534+
"code-review",
535+
"main-branch"
536+
],
537+
"filePath": "docs/anchors/github-flow.adoc"
538+
},
509539
{
510540
"id": "gof-abstract-factory-pattern",
511541
"title": "GoF-Abstract Factory Pattern",

0 commit comments

Comments
 (0)