Skip to content

Enhance documentation and add scripts for composer.json.#549

Open
terabytesoftw wants to merge 4 commits intoyiisoft:masterfrom
terabytesoftw:fix_mini_2
Open

Enhance documentation and add scripts for composer.json.#549
terabytesoftw wants to merge 4 commits intoyiisoft:masterfrom
terabytesoftw:fix_mini_2

Conversation

@terabytesoftw
Copy link
Member

Q A
Is bugfix? ✔️
New feature?
Breaks BC?
Tests pass?

@codecov
Copy link

codecov bot commented Feb 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 18.34%. Comparing base (151c18c) to head (0cf1672).
✅ All tests successful. No failed tests found.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@terabytesoftw terabytesoftw requested a review from a team February 9, 2026 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status:code review The pull request needs review. type:bug Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants