Skip to content

CHANGELOG.md and CONTRIBUTING.md updates#506

Merged
armanist merged 2 commits into
quantum-php:masterfrom
armanist:master
May 6, 2026
Merged

CHANGELOG.md and CONTRIBUTING.md updates#506
armanist merged 2 commits into
quantum-php:masterfrom
armanist:master

Conversation

@armanist

@armanist armanist commented May 6, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Breaking Changes

    • Refactored request/response execution flow to use explicit Response returns, affecting routing handlers, response builders, redirect helpers, middleware behavior, adapters, view caching, and console exit codes.

  • Documentation

    • Simplified development workflow commands for tests, static analysis, and code style checks.
    • Updated commit message format conventions with bracketed issue number style.

armanist added 2 commits May 6, 2026 19:56
@armanist
[quantum-php#470 quantum-php#471 quantum-php#472 quantum-php#473] Doc…
bf0376d 
…ument request/response flow breaking changes in changelog
@armanist
[quantum-php#505] Clarify commit message style and changelog expectat…
edc542b 
…ions in contributing guide
@coderabbitai

coderabbitai Bot commented May 6, 2026 •
edited
Loading

Copy link
Copy Markdown

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

The PR updates project documentation: a changelog entry documenting a breaking change in request/response execution flow, and developer workflow documentation reflecting updated command syntax and commit message conventions.

Changes

Breaking Change Documentation

Layer / File(s) Summary
Changelog Entry
CHANGELOG.md		 New breaking change section detailing request/response execution refactoring, specifying that route handlers, response builders, redirect helpers, middleware, web adapter, view cache, and console start now return explicit Response instances or exit codes.

Development Workflow Updates

Layer / File(s) Summary
Test Execution
CONTRIBUTING.md		 Test runner command simplified from vendor/bin/phpunit --stderr to vendor/bin/phpunit.
Static Analysis
CONTRIBUTING.md		 Static analysis command changed from direct phpstan invocation with memory-limit flags to Composer-based composer phpstan.
Code Style Checks
CONTRIBUTING.md		 Code style check command updated from vendor/bin/php-cs-fixer check to composer cs:check.
Commit Message Convention
CONTRIBUTING.md		 Commit message example format updated to bracketed issue-number style ([#123] Add ...) from plain descriptive format (Add: ...).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The changelog hops with breaking news,
While workflows dance in simpler shoes,
Commands now short, conventions bright,
Documentation shines just right! 📝✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically describes the main changes in the pull request, which involves updates to two documentation files: CHANGELOG.md and CONTRIBUTING.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented May 6, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.70%. Comparing base (af7bdc5) to head (edc542b).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff            @@
##             master     #506   +/-   ##
=========================================
  Coverage     90.70%   90.70%           
  Complexity     2930     2930           
=========================================
  Files           256      256           
  Lines          7711     7711           
=========================================
  Hits           6994     6994           
  Misses          717      717

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@armanist armanist added this to the 3.0.0 milestone May 6, 2026
@armanist armanist merged commit 0628ce3 into quantum-php:master May 6, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

3.0.0

Development

Successfully merging this pull request may close these issues.

1 participant

@armanist