Skip to content

Commit d66aab0

Browse files
Improve project structure docs
Co-authored-by: Felix Arntz <[email protected]>
1 parent 31648f9 commit d66aab0

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

AGENTS.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@ This is a monorepo for the WordPress Performance Team, containing a collection o
66

77
* **Purpose:** To develop and maintain a suite of plugins that improve the performance of WordPress sites. All should be considered potential for future candidates for merging into WordPress core.
88
* **Technologies:** PHP, JavaScript, CSS, a variety of testing and linting tools.
9-
* **Architecture:** This is a monorepo containing multiple WordPress plugins. The main plugin is `performance-lab`, which acts as a hub for performance features, most of which are standalone plugins located in the `plugins` directory (although some come from other repos). Each plugin has its own tests located in its respective `tests` subdirectory.
9+
10+
### Project Structure
11+
12+
* `/bin`: Custom CLI commands and scripts for certain development workflows.
13+
* `/plugins`: The actual WordPress plugins that are developed in this monorepo.
14+
* `/plugins/*`: An individual WordPress plugin folder.
15+
* `/plugins/*/tests`: PHPUnit tests for the specific WordPress plugin.
16+
* `/tools`: Setup and configuration files for various tools, such as linting and testing.
1017

1118
## Building and Running
1219

0 commit comments

Comments
 (0)