Skip to content

docs(contributing): add info about structure, import, and philosophy of axe-core development - #4758

Merged
straker merged 2 commits into
developfrom
contrib-docs
Apr 28, 2025
Merged

docs(contributing): add info about structure, import, and philosophy of axe-core development#4758
straker merged 2 commits into
developfrom
contrib-docs

Conversation

@straker

@straker straker commented Apr 24, 2025

Copy link
Copy Markdown
Contributor

Just wanted to add some information about developing in axe-core.

@straker
straker requested a review from a team as a code owner April 24, 2025 21:27
Comment thread CONTRIBUTING.md Outdated

@dbjorge dbjorge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good improvement, thanks!

It'd be great if a followup PR could enforce some of these conventions rather than just documenting them. In particular:

  • The "no Virtual Nodes in utils" rule could probably be enforced (at least in a best-effort manner) by no-restricted-syntax
  • The import requirements could probably be enforced by eslint rules no-restricted-imports and/oror import/no-restricted-paths

@straker

straker commented Apr 28, 2025

Copy link
Copy Markdown
Contributor Author

I like those ideas!

@straker
straker merged commit 344c65b into develop Apr 28, 2025
@straker
straker deleted the contrib-docs branch April 28, 2025 16:30
straker added a commit that referenced this pull request Sep 24, 2025
Adds eslint rules to restrict import paths from #4758, as well as
virtual node use in utils.

---------

Co-authored-by: Dylan Barrell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants