fix: Update badge styles and links in README.md, reorganize sections for clarity.
#90
Conversation
WalkthroughDocumentation-only update: README badges are refreshed and standardized, sections are reorganized (adding Installation, Quick start, Package information), and examples/headings adjusted. CHANGELOG gains an entry under 0.1.1 noting Bug #90 about badge/style/link updates and section reorganization. No code or public API changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
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: 2
🧹 Nitpick comments (4)
CHANGELOG.md (1)
9-9: Changelog entry looks good; consider linking the PR and add a release date on tag.Append “(#90)” and, when releasing, replace “Under development” with the actual date for 0.1.1.
-- Bug #90: Update badge styles and links in `README.md`, reorganize sections for clarity (@terabytesoftw) +- Bug #90: Update badge styles and links in `README.md`, reorganize sections for clarity (#90, @terabytesoftw)README.md (3)
20-27: Pin workflow badges to the main branch.Without branch=main, the status may reflect a random branch’s last run.
- <img src="https://img.shields.io/github/actions/workflow/status/yii2-extensions/nested-sets-behavior/build.yml?style=for-the-badge&label=PHPUnit" alt="PHPUnit"> + <img src="https://img.shields.io/github/actions/workflow/status/yii2-extensions/nested-sets-behavior/build.yml?branch=main&style=for-the-badge&label=PHPUnit" alt="PHPUnit"> ... - <img src="https://img.shields.io/github/actions/workflow/status/yii2-extensions/nested-sets-behavior/static.yml?style=for-the-badge&label=PHPStan" alt="PHPStan"> + <img src="https://img.shields.io/github/actions/workflow/status/yii2-extensions/nested-sets-behavior/static.yml?branch=main&style=for-the-badge&label=PHPStan" alt="PHPStan">
303-338: Query builder integration: LGTM; minor hint.Good use of phpstan generics. Consider adding a brief note that CategoryQuery should live in its own file/namespace per project conventions.
370-372: Pin Codecov badge to main.Stabilizes reported coverage for readers.
-[](https://codecov.io/gh/yii2-extensions/nested-sets-behavior) +[](https://codecov.io/gh/yii2-extensions/nested-sets-behavior?branch=main)
📜 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(7 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-07-07T12:38:55.463Z
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#66
File: migrations/m250707_103609_tree.php:0-0
Timestamp: 2025-07-07T12:38:55.463Z
Learning: In the yii2-extensions/nested-sets-behavior project, terabytesoftw prefers application-level validation through the NestedSetsBehavior class rather than database-level constraints for nested set integrity. The migrations are meant to be flexible examples since developers may create their own tables.
Applied to files:
README.md
📚 Learning: 2025-07-08T11:14:34.647Z
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#71
File: tests/mssql/ValidationAndStructureTest.php:45-49
Timestamp: 2025-07-08T11:14:34.647Z
Learning: In the yii2-extensions/nested-sets-behavior project, terabytesoftw prefers explicit connection data (including passwords) in unit test files rather than environment variables, since getEnv() can return false and explicit values ensure more reliable test execution.
Applied to files:
README.md
📚 Learning: 2025-07-08T11:14:30.395Z
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#71
File: tests/mssql/QueryBehaviorTest.php:36-55
Timestamp: 2025-07-08T11:14:30.395Z
Learning: In the yii2-extensions/nested-sets-behavior project, terabytesoftw prefers explicit hard-coded test credentials in unit test files rather than environment variables, as getenv() returns false in their test environment. For unit tests, explicitly defining connection data is considered acceptable and more reliable than environment variable configuration.
Applied to files:
README.md
📚 Learning: 2025-07-08T11:14:31.363Z
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#71
File: tests/mssql/ValidationAndStructureTest.php:50-53
Timestamp: 2025-07-08T11:14:31.363Z
Learning: In the yii2-extensions/nested-sets-behavior project, terabytesoftw uses hardcoded database connection credentials in unit tests because environment variables are not reliable in their test environment (getEnv() returns false). They consider hardcoded connection data acceptable for unit tests.
Applied to files:
README.md
🔇 Additional comments (7)
README.md (7)
52-61: Section relocation/readability: LGTM.Clear intro to nested sets with concise bullets.
62-68: “Why nested sets?” additions: LGTM.“Automatic maintenance” and “Depth tracking” clarify benefits.
81-86: Installation snippet: LGTM.Composer command is accurate and minimal.
169-169: “Quick start” heading placement: LGTM.
363-367: Package info badges: LGTM.
376-376: Social badge: LGTM.
380-380: License badge: LGTM.
1 participant
Summary by CodeRabbit