You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .ai/README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# AI and agent documentation
2
2
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.
4
6
5
7
## Rules
6
8
@@ -39,7 +41,7 @@ Additional, more specific rules can be found in the `rules` directory in either
39
41
-**required_sections**: Ensures required sections are present
40
42
-**templates**: Enforces template structure for different ticket types
41
43
-**labels**: Validates that only allowed labels are used
42
-
-**issue_types**: Ensures correct issue type selectionc
44
+
-**issue_types**: Ensures correct issue type selection
43
45
44
46
#### Styles
45
47
@@ -55,7 +57,7 @@ Additional, more specific rules can be found in the `rules` directory in either
55
57
56
58
-**branch_format**: Recommends `username/type-description[-swc-XXX]` format
- 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.
59
61
- Lowercase letters and numbers only, words separated by dashes
60
62
- Severity: Warning (recommended, not required)
61
63
@@ -111,7 +113,7 @@ These two rules share the same glob (`2nd-gen/**/stories/**`) and work as a pair
111
113
112
114
**Always-applied rules:** Rules use `alwaysApply: true` to activate automatically, or `globs` to activate when matching files are edited.
113
115
**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.:
115
117
116
118
-**text_formatting.headings**: Sentence case enforcement with technical term exceptions
117
119
-**text_formatting.patterns**: File patterns for text formatting (`**/*.md`, `**/*.txt`, `**/*.mdx`)
0 commit comments