Skip to content

docs: add AGENTS.md with build commands, code style, and project conventions#688

Merged
superdav42 merged 2 commits intomainfrom
chore/agents-md
Mar 28, 2026
Merged

docs: add AGENTS.md with build commands, code style, and project conventions#688
superdav42 merged 2 commits intomainfrom
chore/agents-md

Conversation

@superdav42
Copy link
Copy Markdown
Collaborator

@superdav42 superdav42 commented Mar 28, 2026

Summary

  • Adds AGENTS.md with build/test/lint commands (including single-test invocation), project structure, PHP/JS/CSS code style guidelines, naming conventions, key patterns (Singleton managers, Base_Model, WP_Error error handling), test conventions, and pre-commit hook setup.
  • Clarifies that "Ultimate Multisite" is the user-facing product name while WP_Ultimo namespace and wu_ prefixes are preserved for backwards compatibility.
  • Notes that *.min.js and *.min.css files are generated during release builds and should not be committed on feature branches.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive project documentation covering development guidelines, coding standards, repository structure, and build/testing workflows.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 28, 2026

Warning

Rate limit exceeded

@superdav42 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 15 minutes and 59 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 15 minutes and 59 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5c6eb8ef-d91a-4df1-bc48-d811315db956

📥 Commits

Reviewing files that changed from the base of the PR and between 3142535 and 4199121.

📒 Files selected for processing (1)
  • AGENTS.md
📝 Walkthrough

Walkthrough

Adds AGENTS.md documentation defining the "Ultimate Multisite" user-facing naming requirement while preserving existing namespace and prefix for backward compatibility. Includes platform requirements, build commands, repository structure, coding standards, and architectural patterns.

Changes

Cohort / File(s) Summary
Documentation
AGENTS.md
New document specifying platform requirements (PHP 7.4+, WP 5.3+), plugin identifiers, build/test/lint commands, repository structure conventions (inc/, tests/, views/, assets/), coding standards for PHP/JS/CSS, and architectural patterns (singletons, BerlinDB models, error handling).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Documentation hops along,
A blueprint clear and strong,
Ultimate paths now shine so bright,
WP_Ultimo holds its might,
Standards and structure, all aligned—
A roadmap for the developer's mind!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly summarizes the main change: adding a new AGENTS.md documentation file with build commands, code style, and project conventions, which matches the raw summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/agents-md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Around line 50-77: The fenced project-structure code block starting with
"ultimate-multisite.php" is missing a language identifier; update that markdown
fence to include a language tag (e.g., add "text" after the opening ``` ) so the
block becomes ```text, which will satisfy markdownlint MD040 and preserve
formatting for the list items shown (ultimate-multisite.php, constants.php,
sunrise.php, inc/, tests/, views/, assets/, etc.).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2138929f-6163-424a-b13e-788bb659aa2e

📥 Commits

Reviewing files that changed from the base of the PR and between 1879949 and 3142535.

📒 Files selected for processing (1)
  • AGENTS.md

@github-actions
Copy link
Copy Markdown

🔨 Build Complete - Ready for Testing!

📦 Download Build Artifact (Recommended)

Download the zip build, upload to WordPress and test:

🌐 Test in WordPress Playground (Very Experimental)

Click the link below to instantly test this PR in your browser - no installation needed!
Playground support for multisite is very limitied, hopefully it will get better in the future.

🚀 Launch in Playground

Login credentials: admin / password

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 28, 2026

Performance Test Results

Performance test results for df16c1d are in 🛎️!

Note: the numbers in parentheses show the difference to the previous (baseline) test run. Differences below 2% or 0.5 in absolute values are not shown.

URL: /

Run DB Queries Memory Before Template Template WP Total LCP TTFB LCP - TTFB
0 41 37.78 MB 854.00 ms 167.50 ms (+7.00 ms / +4% ) 1057.00 ms (-42.50 ms / -4% ) 1986.00 ms (-128.00 ms / -6% ) 1893.00 ms (-129.45 ms / -7% ) 95.00 ms (+4.55 ms / +5% )
1 56 49.01 MB 919.50 ms (-18.50 ms / -2% ) 147.00 ms 1068.50 ms 2046.00 ms 1963.50 ms 82.35 ms

@superdav42
Copy link
Copy Markdown
Collaborator Author

Dispatching worker to address CodeRabbit review suggestion.

  • Branch: chore/agents-md-fix (from chore/agents-md)
  • Scope: Fix MD040 missing language tag on fenced code block at Line 50
  • Attempt: 1 of 1
  • Direction: Add language identifier to the project-structure fenced code block, then push to chore/agents-md branch

aidevops.sh v3.5.77 plugin for OpenCode v1.3.0 with claude-sonnet-4-6 has used 10,476 tokens for 4m.

@github-actions
Copy link
Copy Markdown

🔨 Build Complete - Ready for Testing!

📦 Download Build Artifact (Recommended)

Download the zip build, upload to WordPress and test:

🌐 Test in WordPress Playground (Very Experimental)

Click the link below to instantly test this PR in your browser - no installation needed!
Playground support for multisite is very limitied, hopefully it will get better in the future.

🚀 Launch in Playground

Login credentials: admin / password

@superdav42 superdav42 merged commit 0e36e49 into main Mar 28, 2026
11 checks passed
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.

1 participant