fix(docs): Update command syntax in development.md and testing.md for clarity and consistency.#121
fix(docs): Update command syntax in development.md and testing.md for clarity and consistency.#121terabytesoftw merged 2 commits intomainfrom
development.md and testing.md for clarity and consistency.#121Conversation
… for clarity and consistency.
📝 WalkthroughSummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings. WalkthroughDocumentation, changelog, and composer metadata were updated: a metadata sync workflow and new composer script were introduced; testing and tooling docs were revised (script names, Rector, Infection, PHPStan); CHANGELOG entries were rewritten and a new 0.2.1 bug entry added. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Local as Local Repo
participant Composer as Composer Script
participant Remote as Template Repo (HTTP)
participant FS as Filesystem
Dev->>Local: run `composer sync-metadata`
Local->>Composer: invoke `sync-metadata` script
Composer->>Remote: HTTP GET template/.styleci.yml (curl)
Remote-->>Composer: .styleci.yml (response)
Composer->>FS: write/overwrite .styleci.yml and other synced files
Composer-->>Local: exit status
Local-->>Dev: report success / warnings (overwrites, conflicts)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (3)📓 Common learnings📚 Learning: 2025-09-29T14:58:04.095ZApplied to files:
📚 Learning: 2026-01-23T11:09:08.789ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (16)
🔇 Additional comments (1)
✏️ Tip: You can disable this entire section by setting 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Line 5: The changelog entry "Bug `#121`: Update command syntax in
`development.md` and `testing.md` for clarity and consistency" is too narrow
given the actual docs changes; update the CHANGELOG.md entry for Bug `#121` to
mention the additional documentation additions (Sync Metadata workflow, Rector
section, Infection testing) and broaden the description to reflect major doc
content changes rather than only command syntax edits, referencing the existing
entry text so you modify that specific line.
In `@docs/development.md`:
- Around line 3-42: The changes introduce new Sync Metadata documentation in
docs/development.md (including the sync-metadata command and associated updated
files table) that exceeds the stated PR scope of "updating command syntax for
clarity"; either update the PR title/description to accurately include this new
documentation or extract the docs/development.md additions into a separate PR
focused on workflow documentation (leaving only the command syntax edits in this
PR), and ensure references to the sync-metadata command and the updated files
list are preserved in the new or updated PR as appropriate.
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
CHANGELOG.mdREADME.mddocs/development.mddocs/testing.md
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: terabytesoftw
Repo: php-forge/foxy PR: 115
File: tests/Fallback/AssetFallbackTest.php:158-189
Timestamp: 2026-01-23T11:22:07.261Z
Learning: User terabytesoftw prefers not to use aliases when importing classes in PHP. They are comfortable with either fully-qualified class names or direct imports without aliases.
Learnt from: terabytesoftw
Repo: php-forge/support PR: 12
File: src/TestSupport.php:0-0
Timestamp: 2025-08-18T20:13:33.518Z
Learning: User terabytesoftw prefers clean trait-based designs over maintaining backward compatibility wrappers when refactoring utility classes in the php-forge/support project.
Learnt from: terabytesoftw
Repo: php-forge/actions PR: 65
File: .github/workflows/composer-require-checker.yml:80-83
Timestamp: 2025-09-28T15:12:48.345Z
Learning: The user terabytesoftw prefers using floating tags like v1 for third-party actions in GitHub workflows instead of pinning to specific commit SHAs, even when it's a security best practice to pin to immutable commits.
📚 Learning: 2025-08-18T15:43:30.996Z
Learnt from: terabytesoftw
Repo: php-forge/support PR: 11
File: composer.json:13-16
Timestamp: 2025-08-18T15:43:30.996Z
Learning: Testing helper libraries (packages with "testing" or "support" in keywords/description that provide test utilities) should include PHPUnit and other testing frameworks in the main "require" section rather than "require-dev", as consuming packages need these dependencies to use the testing utilities.
Applied to files:
docs/testing.md
📚 Learning: 2025-09-29T14:58:04.095Z
Learnt from: terabytesoftw
Repo: php-forge/actions PR: 67
File: .github/workflows/phpstan.yml:13-16
Timestamp: 2025-09-29T14:58:04.095Z
Learning: In the php-forge/actions repository, the maintainer prefers using "composer update" as the default command in CI workflows to ensure the latest dependencies are always installed, rather than using "composer install" for reproducibility.
Applied to files:
docs/development.md
📚 Learning: 2026-01-23T11:09:15.771Z
Learnt from: terabytesoftw
Repo: php-forge/foxy PR: 115
File: composer.json:68-77
Timestamp: 2026-01-23T11:09:15.771Z
Learning: In the php-forge organization repositories, terabytesoftw prefers using the main branch reference in composer.json sync-metadata scripts when downloading configuration files from external template repositories, rather than pinning to specific commit SHAs or tags, even though pinning provides more stability and prevents unexpected changes.
Applied to files:
docs/development.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: linter / Super Linter
🔇 Additional comments (13)
README.md (1)
108-115: LGTM! Improved documentation presentation.The emoji-prefixed markdown links enhance readability and provide better visual navigation. The link targets remain unchanged, ensuring no broken references.
docs/development.md (3)
14-27: LGTM! Clear and comprehensive file listing.The table effectively communicates which configuration files are updated and their purposes.
28-42: LGTM! Excellent operational guidance.The "When to Run" scenarios and "Important Notes" provide clear, actionable guidance. The warnings about overwriting files are appropriate and necessary.
3-12: Thecomposer sync-metadatacommand is properly defined incomposer.jsonand the documentation is accurate. No action required.docs/testing.md (9)
3-12: LGTM! Comprehensive tool reference section.The updated tool references clearly document all testing and quality tools used in the project, with proper links to official documentation.
14-20: New documentation section for Rector.This is a new section introducing Rector automated refactoring, not just a command syntax update. While the content is clear and well-structured, it represents an expansion of documentation scope beyond what's described in the PR objectives.
22-28: LGTM! Clear coding standards section.The ECS section is concise and uses the updated composer script naming.
30-36: LGTM! Clear dependency check documentation.The section clearly explains the purpose and usage of the dependency check command.
38-50: New documentation section for mutation testing.These sections introduce Infection mutation testing with two distinct commands. While the documentation is clear and well-organized, this represents new content rather than command syntax updates.
52-58: LGTM! Updated static analysis documentation.The section correctly references PHPStan and uses the updated composer script naming.
60-66: LGTM! Clear unit test documentation.The section uses the updated composer script naming with clear instructions.
68-82: LGTM! Helpful examples of advanced usage.The examples demonstrate how to pass additional arguments to composer scripts, using the updated command names consistently.
14-82: All composer scripts referenced in the documentation are correctly defined incomposer.json: rector, ecs, check-dependencies, mutation, mutation-static, static, and tests. No action required.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #121 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 359 359
===========================================
Files 26 26
Lines 823 823
===========================================
Hits 823 823 ☔ View full report in Codecov by Sentry. |
1 participant
Pull Request