-
-
Notifications
You must be signed in to change notification settings - Fork 2
chore: Update CHANGELOG.md
and README.md
for version 0.1.0
release; adjust composer.json
branch alias.
#134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…ase; adjust `composer.json` branch alias.
WalkthroughDocumentation updated to pin installation commands to version 0.1 and add directory navigation steps. Changelog header date set to August 31, 2025. Composer metadata adjusted: keywords tweaked and branch-alias moved from dev-master 0.1-dev to dev-main 0.2.x-dev. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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 (
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #134 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 7 7
===========================================
Files 12 12
Lines 172 172
===========================================
Hits 172 172 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this 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
🧹 Nitpick comments (2)
CHANGELOG.md (1)
3-3
: Release date update looks good.Heading correctly reflects August 31, 2025 for 0.1.0. Consider adding a compare link to the tag for convenience in future releases.
docs/installation.md (1)
20-23
: Good: version-pinned install. Add Windows-friendly quoting variant.Caret can be special in Windows shells. Provide a quoted alternative alongside the POSIX example.
```bash -composer create-project --prefer-dist yii2-extensions/app-basic:^0.1 app-basic +composer create-project --prefer-dist yii2-extensions/app-basic:^0.1 app-basic cd app-basic+Windows PowerShell:
+powershell +composer create-project --prefer-dist yii2-extensions/app-basic:"^0.1" app-basic +cd app-basic +
</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **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. <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between b32985bf80a600815bffa9a5fe16102906809f87 and 54a8648427459e8757949a61ac5c24e82238ef12. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `CHANGELOG.md` (1 hunks) * `README.md` (1 hunks) * `composer.json` (2 hunks) * `docs/installation.md` (2 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🧠 Learnings (1)</summary> <details> <summary>📚 Learning: 2025-08-25T21:03:02.960Z</summary>
Learnt from: terabytesoftw
PR: #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:** - `docs/installation.md` - `composer.json` - `README.md` </details> </details> </details> <details> <summary>🔇 Additional comments (4)</summary><blockquote> <details> <summary>composer.json (2)</summary><blockquote> `6-9`: **Keyword tweak is fine.** Adding "yii2-extensions" improves discoverability without side effects. --- `58-61`: **Confirm branch-alias strategy post-release.** Mapping dev-main to 0.2.x-dev matches the 0.1.0 release. Ensure the 0.1 maintenance branch is cut (e.g., 0.1) so backports have a target, and Packagist picked up the alias after pushing tags/branches. </blockquote></details> <details> <summary>docs/installation.md (2)</summary><blockquote> `28-31`: **Branch-specific clone looks correct.** Targeting --branch 0.1 and cd'ing into app-basic aligns with the release docs. Please confirm the 0.1 branch exists on origin before merging to avoid 128 errors for users. --- `43-48`: **Git-based setup is consistent with the pinned 0.1 line.** Sequence is sound (clone → cd → reset VCS → init → install). </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Summary by CodeRabbit
Documentation
Chores