Skip to content

Commit df700a4

Browse files
committed
ai(rules[AGENTS]) Add docs/_ext commit message example
why: Clarify commit format for documentation extension changes what: - Add example showing docs() as top-level component for _ext changes - Remove colon from commit message format (space after closing paren)
1 parent d2612da commit df700a4

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

AGENTS.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ def test_sync(
257257

258258
Format commit messages as:
259259
```
260-
Component/File(commit-type[Subcomponent/method]): Concise description
260+
Component/File(commit-type[Subcomponent/method]) Concise description
261261
262262
why: Explanation of necessity or impact.
263263
what:
@@ -274,9 +274,9 @@ Common commit types:
274274
- **test**: Test-related updates
275275
- **style**: Code style and formatting
276276

277-
Example:
277+
Examples:
278278
```
279-
cli/add(feat[add_repo]): Add support for custom remote URLs
279+
cli/add(feat[add_repo]) Add support for custom remote URLs
280280
281281
why: Enable users to specify alternative remote URLs for repositories
282282
what:
@@ -285,6 +285,16 @@ what:
285285
- Add tests for the new functionality
286286
```
287287

288+
For docs/_ext changes, use `docs` as the top-level component:
289+
```
290+
docs(sphinx_argparse_neo[renderer]) Escape asterisks in quoted strings
291+
292+
why: Glob patterns like "django-*" cause RST emphasis issues
293+
what:
294+
- Add _escape_glob_asterisks() helper method
295+
- Call it before RST parsing in _parse_text()
296+
```
297+
288298
## Documentation Standards
289299

290300
### Code Blocks in Documentation

0 commit comments

Comments
 (0)