chore: add CLAUDE.md and pull request checklist - #5035
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing guidance files to standardize PR quality and provide Claude Code with repository-specific development conventions.
Changes:
- Added a PR checklist document covering code style, tests, build, commits, and docs.
- Added
CLAUDE.mddescribing repo standards (imports, testing, logging, commit conventions, and reference docs).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
doc/pull-request-checklist.md |
New PR checklist for contributors/reviewers. |
CLAUDE.md |
New Claude Code context / repo standards reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation intended to standardize PR submissions and provide a “Claude Code Context” reference for working in the axe-core repo.
Changes:
- Add
doc/pull-request-checklist.mdwith a PR checklist covering code style, tests, build steps, commits, and docs. - Add
CLAUDE.mddescribing repository conventions (imports, checks/rules behavior, testing patterns, build/commit expectations) and linking to related docs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
doc/pull-request-checklist.md |
Introduces a PR checklist for contributors/reviewers. |
CLAUDE.md |
Introduces a consolidated contributor “context” doc covering conventions and workflows. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Extract concrete code examples (patterns, tests, rule/check templates, PR review patterns) into doc/examples/ for quick-reference and link them from CLAUDE.md.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation to standardize PR quality, coding/test conventions, and provide Claude Code context for working in the axe-core repository.
Changes:
- Add a PR checklist for common submission requirements (tests, formatting, commit conventions, etc.).
- Add example docs for code patterns, test patterns, and rule/check templates.
- Add
CLAUDE.mdwith repo-specific contribution and architecture guidance.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/pull-request-checklist.md | New PR checklist covering code style, tests, formatting/build, commits, and docs updates. |
| doc/examples/test-patterns.md | Adds quick-reference examples for unit, check-evaluate, Shadow DOM, and rule integration tests. |
| doc/examples/rule-check-templates.md | Adds templates for rule/check JSON and a check evaluate function pattern. |
| doc/examples/pr-review-patterns.md | Summarizes common review feedback and PR anti-patterns for contributors. |
| doc/examples/code-patterns.md | Documents common coding conventions (default export placement, early returns, import restrictions, Virtual Node usage). |
| CLAUDE.md | Adds Claude Code context and consolidated guidance/links for repo standards and workflows. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
straker
previously requested changes
Mar 19, 2026
Update example files based on reviewer feedback: - Replace AbstractVirtuaNode instanceof with nodeLookup pattern - Use queryFixture/queryShadowFixture in test examples - Remove 'use strict', use const, simplify afterEach - Clarify this.data() docs and _template.json auto-generation - Fix axe.js/console.log guidance in PR review patterns - Add notes about integration/full and virtual-rules tests
…and CLAUDE.md Apply @straker's 5 unresolved comments on doc/pull-request-checklist.md: - Simplify console.log guidance to "no console.log statements" - Scope null/undefined testing to public API only - Expand test commands to include build step and all test suites - Add preference for backwards compatibility over breaking changes - Note that rule-descriptions.md is auto-generated Apply matching consistency fixes to CLAUDE.md: - Simplify afterEach guidance (fixture/axe._tree auto-cleared) - Update Shadow DOM to reference queryShadowFixture - Simplify logging to "no console.log" - Note rule-descriptions.md is auto-generated - Add backwards-compatibility preference for breaking changes
Address @straker feedback: integration tests go in integration/rules (mocha-hosted) or integration/full (full HTML page). Virtual-rules tests should also be updated or created for appropriate rules.
Line 60 exclusively pointed to integration/rules/ — updated to mention both integration/rules (mocha-hosted) and integration/full (full page).
Garbee
reviewed
Mar 19, 2026
Add virtual-rules reference to the integration test intro paragraph so all three test locations are mentioned upfront.
Co-authored-by: Jonathan Garbee <[email protected]>
Garbee
approved these changes
Mar 19, 2026
Garbee
left a comment
Garbee
left a comment
Member
There was a problem hiding this comment.
Looks reasonable to me as a starting point. Won't so security review yet. I know David is going to go over it as well.
chutchins25
approved these changes
Mar 19, 2026
chutchins25
left a comment
chutchins25
left a comment
Contributor
There was a problem hiding this comment.
Reviewed with team during Hackathon.
straker
approved these changes
Mar 19, 2026
WilcoFiers
pushed a commit
that referenced
this pull request
Mar 30, 2026
Adds a CLAUDE.md file for contributors --------- Co-authored-by: Copilot Autofix powered by AI <[email protected]> Co-authored-by: Jonathan Garbee <[email protected]>
straker
pushed a commit
that referenced
this pull request
Mar 30, 2026
Adds a CLAUDE.md file for contributors --------- Co-authored-by: Copilot Autofix powered by AI <[email protected]> Co-authored-by: Jonathan Garbee <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a CLAUDE.md file for contributors