Enhance documentation and add scripts for composer.json.#549
Open
terabytesoftw wants to merge 4 commits intoyiisoft:masterfrom
Open
Enhance documentation and add scripts for composer.json.#549terabytesoftw wants to merge 4 commits intoyiisoft:masterfrom
composer.json.#549terabytesoftw wants to merge 4 commits intoyiisoft:masterfrom
Conversation
Member
terabytesoftw
commented
Feb 9, 2026
| Q | A |
|---|---|
| Is bugfix? | ✔️ |
| New feature? | ❌ |
| Breaks BC? | ❌ |
| Tests pass? | ❌ |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #549 +/- ##
=========================================
Coverage 18.34% 18.34%
Complexity 656 656
=========================================
Files 78 78
Lines 3495 3495
=========================================
Hits 641 641
Misses 2854 2854 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds internal contributor documentation and Composer scripts to standardize local validation, while improving PHPDoc annotations to help static analysis (PHPStan) understand Yii-style magic properties.
Changes:
- Added Composer scripts for PHPCS/PHPCBF, PHPStan, and PHPUnit; documented how to run them.
- Improved PHPDoc property annotations across several panels/models to reduce PHPStan noise and improve IDE inference.
- Updated README badges/links and added a changelog entry; adjusted PHPStan baseline.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/panels/UserPanel.php | Adds PHPDoc for $user magic property. |
| src/panels/TimelinePanel.php | Adds PHPDoc for $memory and $svg magic properties. |
| src/panels/DbPanel.php | Adds PHPDoc for several properties (but introduces a type/documentation conflict for $db). |
| src/models/UserSwitch.php | Adds PHPDoc for magic properties (but mainUser nullability is incorrect). |
| src/Panel.php | Documents $error property with getter/setter type difference. |
| src/Module.php | Documents debugHeaders setter-style property. |
| phpstan-baseline.neon | Removes some suppressions and adds new ones (some are avoidable by fixing source PHPDoc). |
| docs/internals.md | New internal doc describing how to run validation via Composer scripts. |
| composer.json | Adds Composer scripts (but static currently won’t run PHPStan correctly). |
| README.md | Updates badges and adds Internals link (Twitter badge URL has a query-string issue). |
| CHANGELOG.md | Adds entry for bug #549. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mspirkov
approved these changes
Feb 9, 2026
s1lver
approved these changes
Feb 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.