Conversation
|
Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.
Interested in more tips and information?
|
|
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖 Follow this PR Review Process:
If you have questions about anything, reach out in #jetpack-developers for guidance! Jetpack plugin: The Jetpack plugin has different release cadences depending on the platform:
If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack. |
There was a problem hiding this comment.
Pull request overview
This PR introduces a codex system to help Claude AI agents (and human developers) navigate the Jetpack Forms package more efficiently. The codex serves as a persistent architecture documentation system that provides quick orientation without requiring developers to re-read thousands of lines of source code.
Changes:
- Added a comprehensive
.codex/documentation system for the Forms package with architecture maps, flow documentation, and file deep-dives - Created command templates (
codex-initandcodex-update) to bootstrap and maintain codex systems for other projects - Updated root and project-level CLAUDE.md files with guidance on using the codex system
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
projects/packages/forms/changelog/test-forms-add-claude-codex |
Changelog entry documenting the addition of the codex system |
projects/packages/forms/CLAUDE.md |
Project-specific documentation with tooling commands and codex reference |
projects/packages/forms/.codex/README.md |
Bootstrap file explaining how to use the codex system |
projects/packages/forms/.codex/map.md |
Architecture overview with file inventory and class relationships |
projects/packages/forms/.codex/references.md |
External dependency references including Gutenberg, WordPress Core, and Jetpack packages |
projects/packages/forms/.codex/log.md |
Creation log documenting initial codex setup |
projects/packages/forms/.codex/flows/*.md |
Five flow documentation files covering form rendering, submission, validation, JWT encryption, and email sending |
projects/packages/forms/.codex/files/*.md |
Three deep-dive documentation files for complex classes (3,000+ lines each) |
CLAUDE.md |
Root-level documentation providing repository overview and development commands |
.claude/CLAUDE.md |
Updated to reference the new codex system |
.claude/commands/codex-init.md |
Command template for bootstrapping new codex systems |
.claude/commands/codex-update.md |
Command template for maintaining codex documentation |
Code Coverage SummaryThis PR did not change code coverage! That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷 Full summary · PHP report · JS report Coverage check overridden by
Coverage tests to be added later
|
| Significance: minor | ||
| Type: added | ||
|
|
||
| Add codex system for Claude to keep track of useful guidelines for our code |
There was a problem hiding this comment.
Changelog entry should follow the repo guidelines (imperative, capitalized, and ending with a period). Line 4 is missing a trailing period, and it may be worth wording it as a user-facing/docs change rather than referencing a specific tool name (“Claude”).
| Add codex system for Claude to keep track of useful guidelines for our code | |
| Add codex system to document useful coding guidelines. |
Forms: update codex with file field email rendering gotchas Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
dbfda24 to
ea81c84
Compare
…ff, use .claude/CLAUDE instead
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
.claude/commands/codex-update.md
Outdated
| ### 6. Log the update | ||
|
|
||
| Append to `.codex/log.md`: | ||
|
|
||
| ```markdown | ||
| ## YYYY-MM-DD — [Brief description of changes] | ||
| - Changed files: [list] | ||
| - Updated codex docs: [list] | ||
| - Notes: [any gaps found, improvements needed] | ||
| ``` |
There was a problem hiding this comment.
This confused Claude in my test. It added a log of the branch changes, not of the changes it made to the codex files (none). We should probably make it clearer that the log is for changex in the codex only, not a changelog of the project.
…odex with new format
WIP
Proposed changes:
Add a thin codex system to keep up with our code major guidelines and processes. The idea is to provide agents with pointers to processes and flows, tooling and commands, so that whenever a task is started it doesn't have to search the entire base.
Other information:
Jetpack product discussion
p1771259406233769-slack-C052XEUUBL4
Does this pull request change what data or activity we track or use?
No
Testing instructions:
TBD