fix(app): Update README.md with new Packagist badges and improve structure.
#156
Conversation
|
Warning Rate limit exceeded@terabytesoftw has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 35 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (1)
WalkthroughDocumentation-only updates: added a new changelog entry under 0.1.1 (Under development) referencing Bug #156, and extensively revised README.md to update Packagist badges/links, add a FrankenPHP Worker badge, restructure headings and sections, and introduce a Quick start installation subsection and notes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10–15 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
21-23: Incorrect Yii version badge (“22.0.x”).Yii2 doesn’t have a “22.0” branch; this looks like a typo/duplicate. Remove it to avoid broken/ misleading link.
Apply this diff:
- <a href="https://github.com/yiisoft/yii2/tree/22.0" target="_blank"> - <img src="https://img.shields.io/badge/22.0.x-0073AA.svg?style=for-the-badge&logo=yii&logoColor=white" alt="Yii 22.0.x"> - </a>
🧹 Nitpick comments (2)
README.md (2)
58-58: Grammar/punctuation: use a colon.Sentence ends abruptly with a period; a colon reads better before the list.
-The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting from scratch, this template includes. +The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting from scratch, this template includes:
65-65: Use a proper heading instead of bold text (MD036).Switch bolded text to a heading for markdownlint compliance and consistency.
-**Why use this template** +### Why use this template
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
CHANGELOG.md(1 hunks)README.md(5 hunks)
🧰 Additional context used
🧠 Learnings (5)
📚 Learning: 2025-08-31T15:34:39.060Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#142
File: README.md:0-0
Timestamp: 2025-08-31T15:34:39.060Z
Learning: In yii2-extensions/app-basic project, the dev-road-runner branch is treated as the main configuration branch with no stable releases available. Static badges pointing to dev branches are intentionally used to direct users to the development version.
Applied to files:
README.md
📚 Learning: 2025-08-31T15:29:19.131Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#142
File: docs/installation.md:21-23
Timestamp: 2025-08-31T15:29:19.131Z
Learning: In yii2-extensions/app-basic project, the composer.json file has "minimum-stability": "dev" configured, which allows Composer to install dev versions automatically without requiring --stability=dev flag in create-project commands.
Applied to files:
README.md
📚 Learning: 2025-08-25T21:03:02.960Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#128
File: docs/installation.md:7-7
Timestamp: 2025-08-25T21:03:02.960Z
Learning: In yii2-extensions/app-basic project, npm is listed as a system requirement in docs/installation.md because the composer.json file contains scripts that depend on npm commands for frontend asset management and build processes.
Applied to files:
README.md
📚 Learning: 2025-08-30T20:39:38.538Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#129
File: config/console/app.php:17-18
Timestamp: 2025-08-30T20:39:38.538Z
Learning: Yii2 provides a built-in `yii serve` command by default that doesn't require custom ServeController configuration in the controllerMap. When custom ServeController entries are removed from console configuration, the default Yii2 serve functionality remains available and documentation should be updated to reflect configuration changes rather than removing serve command references entirely.
Applied to files:
README.md
📚 Learning: 2025-08-30T20:31:14.954Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#129
File: tests/_envs/php-builtin.yml:4-4
Timestamp: 2025-08-30T20:31:14.954Z
Learning: Yii2 framework doesn't require separate router scripts for PHP's built-in server. Yii2 handles routing through URL rules in configuration files and controller/action mapping conventions, not separate route definition files. If tests pass with the built-in server setup, additional router scripts are unnecessary.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.17.2)
README.md
65-65: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (5)
CHANGELOG.md (1)
10-10: Changelog entry looks good.Accurately documents the README/badge restructure under 0.1.1 “Under development.”
README.md (4)
2-2: Top repo link updated correctly.Points to yii2-extensions/app-basic as intended.
9-14: Packagist badges correctly retargeted.Stable and Downloads now reference yii2-extensions/app-basic.
51-52: Verify branch names for worker badges.Confirm that branches exist and are the intended targets:
- franken-php
- road-runner (note: past learnings mention “dev-road-runner” as the main config branch).
In prior work you preferred dev branches for worker stacks. Keep or adjust links for consistency with that convention.
93-94: Fix option name for yii serve.The option is typically --host (and --port), not --address. Adjust note to avoid confusion.
-> Your application will be available at `http://localhost:8080` or at the address set in `--address` option. +> Your application will be available at `http://localhost:8080` (default) or at the host/port set via `--host`/`--port` options.⛔ Skipped due to learnings
Learnt from: terabytesoftw PR: yii2-extensions/app-basic#129 File: config/console/app.php:17-18 Timestamp: 2025-08-30T20:39:38.538Z Learning: Yii2 provides a built-in `yii serve` command by default that doesn't require custom ServeController configuration in the controllerMap. When custom ServeController entries are removed from console configuration, the default Yii2 serve functionality remains available and documentation should be updated to reflect configuration changes rather than removing serve command references entirely.
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
15-20: Invalid/typo badge for "Yii 22.0.x" and broken link."22.0.x" for Yii2 does not exist; the link to /tree/22.0 will 404. You already have a correct "2.0.x" badge above; remove the duplicate/invalid one.
Apply:
- <a href="https://github.com/yiisoft/yii2/tree/22.0" target="_blank"> - <img src="https://img.shields.io/badge/22.0.x-0073AA.svg?style=for-the-badge&logo=yii&logoColor=white" alt="Yii 22.0.x"> - </a>
🧹 Nitpick comments (6)
README.md (6)
9-11: "Stable" Packagist badge may be misleading if no tagged release exists.Given prior context that this project primarily ships dev branches, consider using a pre-release/dev badge or labeling it "Latest" instead of "Stable". If you intend to promote a tagged series, ensure tags (e.g., 0.1.x) exist on Packagist.
Apply one of the following:
-<img src="https://img.shields.io/packagist/v/yii2-extensions/app-basic.svg?style=for-the-badge&logo=packagist&logoColor=white&label=Stable" alt="Latest Stable Version"> +<img src="https://img.shields.io/packagist/vpre/yii2-extensions/app-basic.svg?style=for-the-badge&logo=packagist&logoColor=white&label=Latest" alt="Latest Version">Or, if stable tags exist and you want to keep "Stable", keep as-is after confirming tags are present.
2-27: Add rel="noopener noreferrer" to external links with target="_blank".Small security hardening (prevents window.opener leaks). GitHub renders HTML, so this is applicable.
Example:
- <a href="https://github.com/yii2-extensions/app-basic" target="_blank"> + <a href="https://github.com/yii2-extensions/app-basic" target="_blank" rel="noopener noreferrer">Repeat for other external anchors in the header badge block.
48-51: Verify branch names for worker badges.Earlier learnings indicate the dev-road-runner branch is canonical. The current links point to /tree/franken-php and /tree/road-runner—please confirm actual branch names (e.g., dev-road-runner, frankenphp). Broken links in badges degrade trust.
If needed:
-[](https://github.com/yii2-extensions/app-basic/tree/franken-php) -[](https://github.com/yii2-extensions/app-basic/tree/road-runner) +[](https://github.com/yii2-extensions/app-basic/tree/frankenphp) +[](https://github.com/yii2-extensions/app-basic/tree/dev-road-runner)
55-61: Fix sentence punctuation.“Includes.” ends abruptly; use a colon.
-The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting from scratch, this template includes. +The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting from scratch, this template includes:
62-62: Use a proper heading instead of bold text (markdownlint MD036).Conform to MD036 and improve document structure.
-**Why use this template** +## Why use this template
80-88: Minor copy edit for section lead-in.Add “the” and a colon for consistency with other sections.
-Start development server +Start the development server:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(6 hunks)
🧰 Additional context used
🧠 Learnings (5)
📚 Learning: 2025-08-31T15:34:39.060Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#142
File: README.md:0-0
Timestamp: 2025-08-31T15:34:39.060Z
Learning: In yii2-extensions/app-basic project, the dev-road-runner branch is treated as the main configuration branch with no stable releases available. Static badges pointing to dev branches are intentionally used to direct users to the development version.
Applied to files:
README.md
📚 Learning: 2025-08-31T15:29:19.131Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#142
File: docs/installation.md:21-23
Timestamp: 2025-08-31T15:29:19.131Z
Learning: In yii2-extensions/app-basic project, the composer.json file has "minimum-stability": "dev" configured, which allows Composer to install dev versions automatically without requiring --stability=dev flag in create-project commands.
Applied to files:
README.md
📚 Learning: 2025-08-25T21:03:02.960Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#128
File: docs/installation.md:7-7
Timestamp: 2025-08-25T21:03:02.960Z
Learning: In yii2-extensions/app-basic project, npm is listed as a system requirement in docs/installation.md because the composer.json file contains scripts that depend on npm commands for frontend asset management and build processes.
Applied to files:
README.md
📚 Learning: 2025-08-30T20:39:38.538Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#129
File: config/console/app.php:17-18
Timestamp: 2025-08-30T20:39:38.538Z
Learning: Yii2 provides a built-in `yii serve` command by default that doesn't require custom ServeController configuration in the controllerMap. When custom ServeController entries are removed from console configuration, the default Yii2 serve functionality remains available and documentation should be updated to reflect configuration changes rather than removing serve command references entirely.
Applied to files:
README.md
📚 Learning: 2025-08-30T20:31:14.954Z
Learnt from: terabytesoftw
PR: yii2-extensions/app-basic#129
File: tests/_envs/php-builtin.yml:4-4
Timestamp: 2025-08-30T20:31:14.954Z
Learning: Yii2 framework doesn't require separate router scripts for PHP's built-in server. Yii2 handles routing through URL rules in configuration files and controller/action mapping conventions, not separate route definition files. If tests pass with the built-in server setup, additional router scripts are unnecessary.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.17.2)
README.md
62-62: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (4)
README.md (4)
2-2: Repo link update looks correct.Anchor now points to yii2-extensions/app-basic. No issues spotted.
90-91: Confirm default port note matches ./yii serve defaults.The note is likely correct (8080), but please verify any custom defaults in your Console config.
150-154: Verify external service badges exist/configured (Codecov, StyleCI).Broken badges harm credibility. Ensure Codecov has the repo/branch and StyleCI project ID matches.
Optionally make Codecov branch explicit:
-[](https://codecov.io/github/yii2-extensions/app-basic) +[](https://app.codecov.io/gh/yii2-extensions/app-basic/tree/main)
159-162: Resolved: all referenced docs exist. The Installation, Configuration, Testing, and Screenshots guides are present underdocs/, so no broken links.
Summary by CodeRabbit