Enhance documentation, add scripts for composer.json and apply fixed phpdoc-property annotations.#257
Merged
terabytesoftw merged 5 commits intoyiisoft:masterfrom Feb 14, 2026
Merged
Conversation
Member
terabytesoftw
commented
Feb 11, 2026
| Q | A |
|---|---|
| Is bugfix? | ✔️ |
| New feature? | ❌ |
| Breaks BC? | ❌ |
| Tests pass? | ❌ |
…d `phpdoc-property` annotations.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #257 +/- ##
=========================================
Coverage 98.14% 98.14%
Complexity 268 268
=========================================
Files 16 16
Lines 756 756
=========================================
Hits 742 742
Misses 14 14 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Pull request overview
This PR updates developer-facing documentation and tooling, while adjusting a few PHPDoc property annotations to better reflect the actual API behavior.
Changes:
- Added
composer.jsonscripts for code style checks, static analysis, and tests, and documented how to use them. - Updated PHPDoc property annotations in
RequestandHttpClientPaneland aligned PHPStan baseline entries to the new tags. - Refreshed README badges/logo and added links to the new internal documentation.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
src/debug/HttpClientPanel.php |
Switches $methods/$types PHPDoc to @property-read. |
src/Request.php |
Updates $options property annotation and adds $outputFile property annotation. |
phpstan-baseline.neon |
Adjusts baseline regex messages to match updated PHPDoc tags. |
docs/internals.md |
New doc explaining how to run validation via composer scripts. |
composer.json |
Adds cs, cs-fix, static, tests scripts. |
README.md |
Updates branding/badges and links to internals doc. |
CHANGELOG.md |
Adds an entry documenting the change set. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mspirkov
approved these changes
Feb 12, 2026
mspirkov
reviewed
Feb 12, 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.