Skip to content

Commit 286ea0c

Browse files
docs(agents.md): update project overview and add commit message conventions
1 parent 6f4e47b commit 286ea0c

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file defines repository-wide guidance for AI agents working in Ignite UI fo
44

55
## Project Overview
66

7-
Ignite UI for Angular is a comprehensive UI component library built on Angular 21+. It provides 60+ components including grids, charts, form controls, layout containers, and data visualization widgets.
7+
Ignite UI for Angular is a comprehensive UI component library built on the Angular framework.
88

99
- **Language**: TypeScript (strict mode)
1010
- **Framework**: Angular 21+
@@ -115,4 +115,26 @@ Feature implementation is handled by a set of specialized agents in `.github/age
115115
| `bug-fixing-agent` | `bug-fixing-agent.md` | Investigates and fixes bugs following a TDD workflow |
116116
| `migration-agent` | `migration-agent.md` | Creates `ng update` migration schematics for breaking changes |
117117
| `changelog-agent` | `changelog-agent.md` | Updates `CHANGELOG.md` following repo conventions |
118-
| `validator-agent` | `validator-agent.md` | Runs lint, build, and all test suites to verify correctness |
118+
119+
## Commit Message Conventions
120+
121+
When creating or suggesting a commit message, follow this format:
122+
123+
`<type>(<scope>): <subject>`
124+
125+
Allowed `<type>` values:
126+
- `feat` — new feature
127+
- `fix` — bug fix
128+
- `test` — tests added or updated
129+
- `docs` — documentation only
130+
- `refactor` — code change without fixing a bug or adding a feature
131+
- `perf` — performance improvement
132+
- `style` — formatting or style-only changes with no logic change
133+
- `chore` — maintenance, tooling, or housekeeping work
134+
- `ci` — CI/CD or workflow changes
135+
136+
Rules:
137+
- Use a clear subject with at least 15 characters.
138+
- Keep each line within 80 characters.
139+
- If the scope is unclear, use `(*)`.
140+
- Use the current component, directive, service, or area as the scope when possible.

0 commit comments

Comments
 (0)