Skip to content

Commit 66be71e

Browse files
georgianastasovgeorgianastasov
committed
docs(readme): refine README agent workflow structure and new agents
1 parent f52ffb0 commit 66be71e

1 file changed

Lines changed: 57 additions & 20 deletions

File tree

‎.github/README.md‎

Lines changed: 57 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The agent system keeps AI-assisted work **modular, consistent, and reviewable**.
3030
Instead of one general agent doing everything, work is split into two roles:
3131

3232
- **Orchestrators** analyze scope, decide follow-through, and route work.
33-
- **Specialists** handle one focused responsibility well, such as tests, implementation, docs, migrations, or changelog updates.
33+
- **Specialists** handle one focused responsibility well, such as tests, implementation, theming/styles, demo updates, docs, migrations, or changelog updates.
3434

3535
---
3636

@@ -72,6 +72,18 @@ Instead of one general agent doing everything, work is split into two roles:
7272
└──────────────┬──────────────┘
7373
│
7474
▼
75+
┌──────────────────────────────┐
76+
│ theming-styles-agent │
77+
│ (if needed) │
78+
└──────────────┬───────────────┘
79+
│
80+
▼
81+
┌──────────────────────────────┐
82+
│ demo-sample-agent │
83+
│ (if explicitly requested) │
84+
└──────────────┬───────────────┘
85+
│
86+
▼
7587
┌───────────────────────────┐
7688
│ Optional when needed │
7789
└──────────────┬────────────┘
@@ -80,14 +92,13 @@ Instead of one general agent doing everything, work is split into two roles:
8092
┌──────────────────────────┐ ┌──────────────────┐ ┌──────────────────┐
8193
│ component-readme-agent │ │ migration-agent │ │ changelog-agent │
8294
└──────────────────────────┘ └──────────────────┘ └──────────────────┘
83-
┌──────────────────────────┐ ┌──────────────────────────┐
84-
│ theming-styles-agent │ │ demo-sample-agent │
85-
└──────────────────────────┘ └──────────────────────────┘
8695
```
8796

8897
- one core workflow is selected: **feature** or **bug**
8998
- **TDD tests come first**
9099
- implementation follows
100+
- theming/style work follows implementation **when needed**
101+
- demo/sample work happens **only when explicitly requested**
91102
- README, migration, and changelog work are **optional follow-through**
92103

93104
---
@@ -102,7 +113,7 @@ Instead of one general agent doing everything, work is split into two roles:
102113
| [`feature-implementer-agent`](./agents/feature-implementer-agent.md) | Specialist | Feature implementation and refactor |
103114
| [`bug-fixing-implementer-agent`](./agents/bug-fixing-implementer-agent.md) | Specialist | Minimum safe bug fix |
104115
| [`theming-styles-agent`](./agents/theming-styles-agent.md) | Specialist | Component theming, structural SCSS, theme wiring, and style validation |
105-
| [`demo-sample-agent`](./agents/demo-sample-agent.md) | Specialist | Demo/sample updates in `src/app/` for user-visible changes |
116+
| [`demo-sample-agent`](./agents/demo-sample-agent.md) | Specialist | Demo/sample updates in `src/app/` for explicitly requested user-visible changes |
106117
| [`component-readme-agent`](./agents/component-readme-agent.md) | Specialist | Component README updates |
107118
| [`migration-agent`](./agents/migration-agent.md) | Specialist | `ng update` migration for breaking changes |
108119
| [`changelog-agent`](./agents/changelog-agent.md) | Specialist | `CHANGELOG.md` updates |
@@ -117,13 +128,15 @@ Orchestrators are responsible for:
117128

118129
- understanding the request at a high level
119130
- identifying affected components and files
120-
- mapping impact such as breaking changes, docs impact, changelog impact, accessibility, i18n, or demos
131+
- mapping impact such as breaking changes, docs impact, changelog impact, accessibility, i18n, theming/styles impact, or demo/sample follow-through
121132
- deciding which specialist agents are needed
122133
- routing work in the correct order
123134
- verifying that nothing important was missed
124135

125136
Orchestrators do **not** act as detailed spec writers. They should pass minimal context and avoid over-constraining downstream agents.
126137

138+
Orchestrators also decide whether optional follow-through is needed after implementation or bug fixing.
139+
127140
### 2. Specialists
128141

129142
Specialist agents own a single focused responsibility.
@@ -132,8 +145,8 @@ Examples:
132145

133146
- the TDD agent writes failing tests
134147
- implementer agents write production code
135-
- the theming agent handles SCSS and theme wiring
136-
- the demo agent updates demo/sample pages
148+
- the theming agent handles SCSS, theme wiring, and style validation
149+
- the demo agent updates demo/sample pages in `src/app/` when a demo is explicitly requested
137150
- the README agent updates component docs
138151
- the migration agent handles `ng update` migrations for breaking changes
139152
- the changelog agent updates release notes in the correct section
@@ -150,7 +163,7 @@ Examples:
150163
| Implement a known feature | `feature-implementer-agent` |
151164
| Implement a known bug fix | `bug-fixing-implementer-agent` |
152165
| Style or theme a component | `theming-styles-agent` |
153-
| Update demo for a user-visible change | `demo-sample-agent` |
166+
| Update demo for an explicitly requested user-visible change | `demo-sample-agent` |
154167
| Update docs after public change | `component-readme-agent` |
155168
| Add migration for breaking change | `migration-agent` |
156169
| Add release-note coverage | `changelog-agent` |
@@ -192,6 +205,18 @@ Use the feature flow when the task is about **new behavior**, **new public API**
192205
▼
193206
┌──────────────────────────────┐
194207
│ feature-implementer-agent │
208+
└──────────────┬───────────────┘
209+
│
210+
▼
211+
┌──────────────────────────────┐
212+
│ theming-styles-agent │
213+
│ (if needed) │
214+
└──────────────┬───────────────┘
215+
│
216+
▼
217+
┌──────────────────────────────┐
218+
│ demo-sample-agent │
219+
│ (if explicitly requested) │
195220
└──────────────┬───────────────┘
196221
│
197222
▼
@@ -206,9 +231,6 @@ Use the feature flow when the task is about **new behavior**, **new public API**
206231
│ component- │ │ migration-│ │ changelog- │
207232
│ readme-agent │ │ agent │ │ agent │
208233
└──────────────┘ └───────────┘ └──────────────┘
209-
┌──────────────────────────┐ ┌───────────────────┐
210-
│ theming-styles-agent │ │ demo-sample-agent │
211-
└──────────────────────────┘ └───────────────────┘
212234
│
213235
▼
214236
┌──────────────────────────────┐
@@ -221,6 +243,8 @@ Use the feature flow when the task is about **new behavior**, **new public API**
221243
- affected files and components
222244
- deprecations or API changes
223245
- accessibility and i18n impact
246+
- whether theming/style follow-through is needed
247+
- whether a demo/sample update was explicitly requested
224248
- whether README, migration, or changelog work is needed
225249
- smallest relevant test suite
226250

@@ -230,9 +254,11 @@ The order keeps the workflow grounded:
230254

231255
1. **Tests first** — define the missing behavior.
232256
2. **Implementation second** — satisfy the real feature contract, not just the tests literally.
233-
3. **Documentation follow-through** — reflect actual public changes.
234-
4. **Migration follow-through** — automate breaking changes.
235-
5. **Changelog follow-through** — record notable release information.
257+
3. **Theming/style follow-through** — handle SCSS and theme-system work when needed.
258+
4. **Demo follow-through** — update samples only when explicitly requested.
259+
5. **Documentation follow-through** — reflect actual public changes.
260+
6. **Migration follow-through** — automate breaking changes.
261+
7. **Changelog follow-through** — record notable release information.
236262

237263
---
238264

@@ -273,6 +299,18 @@ Use the bug-fix flow when the task is about **broken existing behavior**, **regr
273299
▼
274300
┌──────────────────────────────┐
275301
│ bug-fixing-implementer-agent │
302+
└──────────────┬───────────────┘
303+
│
304+
▼
305+
┌──────────────────────────────┐
306+
│ theming-styles-agent │
307+
│ (if needed) │
308+
└──────────────┬───────────────┘
309+
│
310+
▼
311+
┌──────────────────────────────┐
312+
│ demo-sample-agent │
313+
│ (if explicitly requested) │
276314
└──────────────┬───────────────┘
277315
│
278316
▼
@@ -287,9 +325,6 @@ Use the bug-fix flow when the task is about **broken existing behavior**, **regr
287325
│ component- │ │ migration-│ │ changelog- │
288326
│ readme-agent │ │ agent │ │ agent │
289327
└──────────────┘ └───────────┘ └──────────────┘
290-
┌──────────────────────────┐ ┌───────────────────┐
291-
│ theming-styles-agent │ │ demo-sample-agent │
292-
└──────────────────────────┘ └───────────────────┘
293328
│
294329
▼
295330
┌──────────────────────────────┐
@@ -304,6 +339,7 @@ Compared with feature work, bug fixing adds stronger emphasis on:
304339
- **root-cause analysis before routing**
305340
- **reproduction-first testing**
306341
- **minimal fixes** rather than scope expansion
342+
- **theming/style separation** when the required fix belongs in SCSS or theme wiring
307343
- **multi-branch handling** when the bug affects release branches
308344
- **edge-case escalation** when the issue is not reproducible, is by design, or is caused by a third party
309345

@@ -320,7 +356,7 @@ Use this quick decision guide:
320356
| Only need failing tests first | `tdd-test-writer-agent` |
321357
| Already have failing tests and need implementation | `feature-implementer-agent` or `bug-fixing-implementer-agent` |
322358
| Styling or theming a component | `theming-styles-agent` |
323-
| Demo update needed for user-visible change | `demo-sample-agent` |
359+
| Demo update explicitly requested for a user-visible change | `demo-sample-agent` |
324360
| Public behavior changed and docs must be updated | `component-readme-agent` |
325361
| Breaking change needs `ng update` support | `migration-agent` |
326362
| User-visible change needs release-note coverage | `changelog-agent` |
@@ -343,7 +379,7 @@ If the task is narrow and clearly scoped, start directly with the **specialist**
343379
| `feature-implementer-agent` | feature scope is known and implementation is next | the task is really a bug fix |
344380
| `bug-fixing-implementer-agent` | the bug is understood and needs the smallest safe fix | the task is actually a feature |
345381
| `theming-styles-agent` | SCSS, theme wiring, or style validation is needed | no styling impact exists |
346-
| `demo-sample-agent` | a demo is explicitly requested for a user-visible change | the change has no UI impact or sample coverage |
382+
| `demo-sample-agent` | a demo is explicitly requested for a user-visible change | the change has no UI impact or no demo/sample was requested |
347383
| `component-readme-agent` | public API or documented behavior changed | no docs impact exists |
348384
| `migration-agent` | a breaking change needs migration support | the change is additive only |
349385
| `changelog-agent` | the change deserves release-note coverage | the change is too minor for changelog |
@@ -360,6 +396,7 @@ projects/igniteui-angular/<component>/index.ts public barrel
360396
projects/igniteui-angular/<component>/README.md component documentation
361397
projects/igniteui-angular/test-utils/ shared test helpers
362398
projects/igniteui-angular/migrations/ migration schematics
399+
projects/igniteui-angular/core/src/core/styles/ theming and shared style infrastructure
363400
CHANGELOG.md root changelog
364401
src/app/<component>/ demo pages
365402
```

0 commit comments

Comments
 (0)