Skip to content

[docs] Add MDX style checklist to AGENTS.md #6696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bharvey88 wants to merge 1 commit into from
Closed

[docs] Add MDX style checklist to AGENTS.md #6696

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,17 @@ For repository structure and local development setup, see the [README](README.md

@CONTRIBUTING.md

## Verifying Style Before Submitting

After generating or modifying MDX content, verify against the
[Before Submitting](CONTRIBUTING.md#before-submitting) checklist in CONTRIBUTING.md. Items easy to overlook:

- Section titles in Title Case
- Variable names and short code snippets wrapped in backticks
- Markdown syntax preferred when it produces the same result as raw HTML
- Repeated HTML or CSS structure may be a candidate for a reusable Astro component — flag in the PR description
if you're not sure

## Guidelines for AI Generated Reviews and PR Summaries

Avoid the use of flowery language and weasel-words that add no useful content. Keep comments concise and technically
Expand Down