Skip to content

Commit 46dfc1d

Browse files
docs(.ai): tweaks to readme language
1 parent e70878c commit 46dfc1d

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

.ai/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# AI and agent documentation
22

3-
This directory contains rules and skills that coding agents uses to enforce consistent formatting and structure in our codebase.
3+
Coding agents should start with [`AGENTS.md`](../AGENTS.md) at the repository root. It summarizes how to use this directory as the canonical source for rules and skills.
4+
5+
This directory contains rules and skills that coding agents use to enforce consistent formatting and structure in our codebase.
46

57
## Rules
68

@@ -39,7 +41,7 @@ Additional, more specific rules can be found in the `rules` directory in either
3941
- **required_sections**: Ensures required sections are present
4042
- **templates**: Enforces template structure for different ticket types
4143
- **labels**: Validates that only allowed labels are used
42-
- **issue_types**: Ensures correct issue type selectionc
44+
- **issue_types**: Ensures correct issue type selection
4345

4446
#### Styles
4547

@@ -55,7 +57,7 @@ Additional, more specific rules can be found in the `rules` directory in either
5557

5658
- **branch_format**: Recommends `username/type-description[-swc-XXX]` format
5759
- Uses conventional commit types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
58-
- Commit type list and validation pattern: `.cursor/config.json` (`git.types`, `validationPattern`). When adding or removing a type, update both `types` and `validationPattern` together.
60+
- Commit type list and validation pattern: `.ai/config.json` (`git.types`, `validationPattern`). When adding or removing a type, update both `types` and `validationPattern` together.
5961
- Lowercase letters and numbers only, words separated by dashes
6062
- Severity: Warning (recommended, not required)
6163

@@ -111,7 +113,7 @@ These two rules share the same glob (`2nd-gen/**/stories/**`) and work as a pair
111113

112114
**Always-applied rules:** Rules use `alwaysApply: true` to activate automatically, or `globs` to activate when matching files are edited.
113115
**On-demand rules:** Rules with `alwaysApply: false` and no globs are on-demand only (activated by `@` mentioning them in chat).
114-
**Config-based rules:** The `config.json` also defines structured validation for Cursor (or other tooling) to verify branch names, Jira ticket drafts, text-formatting, etc.:
116+
**Config-based rules:** The `config.json` also defines structured validation for editors and other tooling to verify branch names, Jira ticket drafts, text-formatting, etc.:
115117

116118
- **text_formatting.headings**: Sentence case enforcement with technical term exceptions
117119
- **text_formatting.patterns**: File patterns for text formatting (`**/*.md`, `**/*.txt`, `**/*.mdx`)

0 commit comments

Comments
 (0)