Skip to content

Commit e16eeed

Browse files
authored
Merge pull request #17113 from IgniteUI/ganastasov/align-agents-md-with-repo-workflow
feat(agents): Align AGENTS.md with repo workflow and improve orchestrators
2 parents 5eb6098 + ade8521 commit e16eeed

File tree

3 files changed

+59
-30
lines changed

3 files changed

+59
-30
lines changed

.github/agents/bug-fixing-orchestrator-agent.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,15 @@ Present a brief scope summary to the user:
172172

173173
Keep it short and high-level. Confirm scope, not solution details.
174174

175-
Wait for user confirmation.
175+
Before routing any work, ask:
176176

177-
If a demo/sample is relevant, ask explicitly:
178-
`Do you want a demo/sample update for this change? Yes / No`
177+
**`Do you want me to proceed with this implementation flow?`**
178+
179+
If the fix is user-visible, also ask:
180+
181+
**`Do you want a demo/sample update for this feature?`**
182+
183+
Wait for the user's answer before routing work.
179184

180185
### Step 4 — Route Work
181186

.github/agents/feature-orchestrator-agent.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,15 @@ Present a brief scope summary to the user:
153153

154154
Keep it short and high-level. Confirm scope, not solution details.
155155

156-
Wait for user confirmation.
156+
Before routing any work, ask:
157157

158-
If a demo/sample is relevant, ask explicitly:
159-
`Do you want a demo/sample update for this feature? Yes / No`
158+
**`Do you want me to proceed with this implementation flow?`**
159+
160+
If the feature is user-visible, also ask:
161+
162+
**`Do you want a demo/sample update for this feature?`**
163+
164+
Wait for the user's answer before routing work.
160165

161166
### Step 4 — Route Work
162167

AGENTS.md

Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,23 @@ Ignite UI for Angular is a comprehensive UI component library built on the Angul
1414

1515
## Repository Structure
1616

17-
```
18-
.github/ ← contributing docs, templates, workflows, Copilot instructions
17+
```text
18+
.github/ ← contributing docs, agent docs, templates, workflows, Copilot instructions
19+
agents/ ← custom agent definitions and handoff workflows
20+
copilot-instructions.md ← repository coding standards and AI-specific guidance
1921
cypress/ ← repository-level Cypress setup/tests
2022
projects/
2123
bundle-test/ ← auxiliary bundle test project
2224
igniteui-angular/ ← main Angular component library
2325
<component>/ ← component entry points (accordion, combo, slider, etc.)
2426
core/ ← shared core code, styles, and related infrastructure
27+
src/core/styles/ ← shared Sass theme infrastructure used by theming/style work
2528
cypress/ ← library-scoped Cypress tests/assets
29+
directives/ ← shared directives and directive-level documentation areas
2630
grids/ ← grid-related library area
2731
migrations/ ← `ng update` migrations
32+
common/ ← shared migration utilities
33+
migration-collection.json ← registered migration entry points
2834
schematics/ ← `ng add` / schematics
2935
src/ ← shared library sources
3036
test-utils/ ← shared test helpers
@@ -35,7 +41,9 @@ projects/
3541
scripts/ ← build, docs, packaging, and style scripts
3642
skills/ ← AI skill guides for components, grids, and theming
3743
src/app/ ← demo application
44+
<component>/ ← existing demo/sample areas reused for user-visible changes
3845
CHANGELOG.md ← release notes
46+
SECURITY.md ← supported-version policy for multi-branch bug fixes
3947
css-naming-convention.md ← CSS naming rules
4048
```
4149

@@ -48,21 +56,27 @@ css-naming-convention.md ← CSS naming rules
4856
### Always
4957

5058
- Reuse existing repository patterns before introducing new abstractions.
51-
- Read existing source and tests before editing.
52-
- Run `npm run lint:lib` and the relevant test suite before considering work complete.
59+
- Read the original request, existing source, and existing tests before editing.
60+
- Read the relevant skill file before modifying component code.
61+
- If a skill points to reference files, read the relevant reference files before editing.
62+
- If the task changes behavior or fixes a bug, write or update failing tests before production code.
63+
- Reuse the existing spec structure whenever possible.
64+
- Run the smallest relevant test suite and `npm run lint:lib` before considering work complete.
65+
- Run additional checks when applicable, such as `npm run lint:styles`, `npm run test:styles`, `npm run test:schematics`, `npm run build:migrations`, or i18n-specific checks.
5366
- Export new public symbols from `<component>/index.ts`.
5467
- Keep accessibility intact: ARIA, keyboard navigation, focus behavior, and screen reader semantics.
5568
- Keep i18n intact when user-facing text changes.
5669
- Add JSDoc with `@param`, `@returns`, and `@example` on every new public member.
70+
- Treat SCSS, theme wiring, and style-test work as dedicated theming/styles follow-through, and validate it with the relevant style checks when needed.
5771
- Add or update `ng update` migrations for true breaking changes such as removals, renames, moved entry points, selector changes, or incompatible default-behavior changes.
58-
- Update the component `README.md` when the public API surface changes.
59-
- Update relevant Agent skills if a change is significant and/or you need to tell other agents how to use the newly introduced feature.
72+
- Update the component `README.md` when public API, documented usage, or documented behavior changes, including new features, renamed or deprecated API, and behavior changes.
6073
- Consider demo/sample updates in `src/app/` only for explicitly requested user-visible changes.
61-
- Update `CHANGELOG.md` for new features, deprecations, breaking changes, and notable user-visible fixes when they fit the existing changelog section structure.
74+
- Update `CHANGELOG.md` for new features, deprecations, breaking changes, behavioral changes, and notable user-visible fixes when they fit the existing changelog section structure.
75+
- Update relevant Agent skills if a change is significant and/or you need to tell other agents how to use the newly introduced feature.
6276

6377
### Never
6478

65-
- Skip steps in the implementation.
79+
- Skip steps in the implementation.
6680
- Commit secrets, tokens, or credentials.
6781
- Introduce `eval()` or dynamic code execution.
6882
- Modify `package.json`, `package-lock.json`, or any other dependency manifest or lock file. If a dependency change appears truly necessary, ask for approval first. Never commit `package-lock.json` unless you have been explicitly approved to make dependency changes — committing unintended lock file changes can break builds.
@@ -107,23 +121,28 @@ Domain-specific knowledge for AI assistants:
107121

108122
## Custom Agents
109123

110-
Feature implementation is handled by a set of specialized agents in `.github/agents/`:
124+
The repository provides a set of agents in `.github/agents/`. Orchestrators analyze requests, define scope, and route work to the right specialists; they do not implement code directly. Specialists handle focused implementation and follow-through tasks.
111125

112-
| Agent | File | Purpose |
113-
|---|---|---|
114-
| `feature-orchestrator-agent` | `feature-orchestrator-agent.md` | Orchestrates end-to-end feature implementation via TDD |
115-
| `bug-fixing-orchestrator-agent` | `bug-fixing-orchestrator-agent.md` | Orchestrates end-to-end bug fixing via TDD |
116-
| `tdd-test-writer-agent` | `tdd-test-writer-agent.md` | Writes failing tests (RED phase) for features and bug fixes |
117-
| `feature-implementer-agent` | `feature-implementer-agent.md` | Implements features and refactors (GREEN + REFACTOR phases) |
118-
| `bug-fixing-implementer-agent` | `bug-fixing-implementer-agent.md` | Implements the minimum bug fix (GREEN phase) |
119-
| `theming-styles-agent` | `theming-styles-agent.md` | Implements component theming, structural SCSS, theme wiring, and style validation |
120-
| `demo-sample-agent` | `demo-sample-agent.md` | Updates existing demo/sample areas in `src/app/` when a demo is explicitly requested for a user-visible feature or bug fix |
121-
| `component-readme-agent` | `component-readme-agent.md` | Updates affected component `README.md` files for public API and documented behavior changes |
122-
| `migration-agent` | `migration-agent.md` | Creates `ng update` migration schematics for breaking changes |
123-
| `changelog-agent` | `changelog-agent.md` | Updates `CHANGELOG.md` following repo conventions |
124-
125-
Feature and bug orchestrators route work in this order:
126-
TDD → implementer → README (if needed) → migration (if breaking) → changelog (if needed).
126+
| Agent | Role | File | Use it for |
127+
|---|---|---|---|
128+
| `feature-orchestrator-agent` | Orchestrator | `feature-orchestrator-agent.md` | Analyzing feature requests, defining scope, deciding which specialists are needed, and routing the work. Does not implement code directly. |
129+
| `bug-fixing-orchestrator-agent` | Orchestrator | `bug-fixing-orchestrator-agent.md` | Analyzing bug reports, confirming likely scope and root-cause direction, deciding which specialists are needed, and routing the work. Does not implement code directly. |
130+
| `tdd-test-writer-agent` | Specialist | `tdd-test-writer-agent.md` | Writing small failing tests before production code for features and bug fixes |
131+
| `feature-implementer-agent` | Specialist | `feature-implementer-agent.md` | Implementing a feature or feature-side refactor after scope and tests are clear |
132+
| `bug-fixing-implementer-agent` | Specialist | `bug-fixing-implementer-agent.md` | Implementing the minimum safe bug fix once reproduction and root cause are known |
133+
| `theming-styles-agent` | Specialist | `theming-styles-agent.md` | Component SCSS, theme wiring, structural styles, and style validation |
134+
| `demo-sample-agent` | Specialist | `demo-sample-agent.md` | Updating existing `src/app/` demo/sample areas for explicitly requested user-visible changes |
135+
| `component-readme-agent` | Specialist | `component-readme-agent.md` | Updating affected component `README.md` files when public API or documented behavior changes |
136+
| `migration-agent` | Specialist | `migration-agent.md` | Creating `ng update` migrations for true breaking changes |
137+
| `changelog-agent` | Specialist | `changelog-agent.md` | Updating `CHANGELOG.md` for notable user-visible changes |
138+
139+
These agents are available as specialized helpers for repository work. Select and use the relevant subagent when it adds clarity, specialization, or better task separation, but do not treat subagent use as mandatory — an agent may decide to handle the work directly as long as it follows the same repository workflow, standards, and validation steps.
140+
141+
## Workflow
142+
143+
### Standard default flow
144+
145+
TDD (write or update failing tests first) → feature implementation or bug-fix implementation → theming/styles follow-through (only when the change affects SCSS, theme wiring, or style-test validation) → demo/sample update (only if explicitly requested) → component README update (when needed) → migration (for breaking changes) → changelog update (when needed).
127146

128147
## Commit Message Conventions
129148

0 commit comments

Comments
 (0)