Skip to content

Add AGENTS.md, TESTS.md and CLAUDE.md#840

Merged
masteradhoc merged 2 commits intomasterfrom
add/AGENTS.md
Mar 18, 2026
Merged

Add AGENTS.md, TESTS.md and CLAUDE.md#840
masteradhoc merged 2 commits intomasterfrom
add/AGENTS.md

Conversation

@georgestephanis
Copy link
Copy Markdown
Collaborator

This pull request adds comprehensive documentation for the development, architecture, and testing of the Two-Factor WordPress plugin. It introduces a new AGENTS.md file with detailed developer instructions and architecture notes, a new TESTS.md file with an in-depth guide to the test suite, and updates CLAUDE.md to reference the new documentation.

Documentation improvements:

  • Added AGENTS.md with detailed instructions on development environment setup, build process, code standards, plugin architecture, provider registration, and REST API usage.
  • Added TESTS.md describing the test environment, running and filtering tests, coverage reporting, and detailed breakdowns of each test file and provider.
  • Updated CLAUDE.md to reference the new AGENTS.md documentation.

Add documentation for development and testing: AGENTS.md describes the Two-Factor plugin development environment (Docker/@wordpress/env), build/test/lint commands, architecture and provider patterns, login flow, provider registration, key user meta, REST API, and coding standards. TESTS.md documents how to run the PHPUnit suite inside the wp-env container, coverage, filtering, and provides an overview of the test files and what each test class covers. CLAUDE.md is a simple pointer to AGENTS.md.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 18, 2026

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core SVN

If you're a Core Committer, use this list when committing to wordpress-develop in SVN:

Props: georgestephanis, masteradhoc.

GitHub Merge commits

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: georgestephanis <georgestephanis@git.wordpress.org>
Co-authored-by: masteradhoc <masteradhoc@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Copy Markdown
Collaborator

@masteradhoc masteradhoc left a comment

Choose a reason for hiding this comment

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

shall we note that the core files in includes shall not be edited?

@georgestephanis
Copy link
Copy Markdown
Collaborator Author

shall we note that the core files in includes shall not be edited?

Sure, wanna add it?

@masteradhoc masteradhoc merged commit f3ede1f into master Mar 18, 2026
32 of 56 checks passed
@masteradhoc masteradhoc deleted the add/AGENTS.md branch March 18, 2026 19:24
@masteradhoc masteradhoc added this to the 0.16.0 milestone Mar 19, 2026
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.

2 participants