doc(versions): version visibility docs and Unit/Feature test split#17
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Improves version visibility and upgrade documentation on the default branch by adding status/branch links in the README and expanding the upgrade guide to include the full 1→2→3 path, while also reorganizing the PHPUnit test suites/namespaces.
Changes:
- Add a “Status” column and include a 1.x row in the README requirements table, linking to
v1/v2branches. - Extend
UPGRADE.mdwith a 1.x → 2.0 section and update 2.x guidance; add a 3.0 → 3.1 note about default redaction behavior. - Split PHPUnit suites into
Unit/Featuredirectories and update test namespaces; ignore PHPUnit result cache file.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| UPGRADE.md | Adds 1.x → 2.0 section, updates 2.x messaging, and adds 3.0 → 3.1 behavioral note. |
| README.md | Adds a status column and v1/v2 links to the requirements table. |
| tests/Unit/RedactorTest.php | Moves test into Tests\\Unit namespace and avoids base TestCase collision. |
| tests/Feature/LogApiRequestMiddlewareTest.php | Moves test into Tests\\Feature namespace and imports package TestCase explicitly. |
| tests/Feature/HasApiLogsTest.php | Moves test into Tests\\Feature namespace and imports package TestCase explicitly. |
| phpunit.xml | Splits test suites into Unit and Feature directories. |
| .gitignore | Adds PHPUnit result cache to ignored files. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Description
Version-visibility docs on the default branch, plus the Laravel-convention test layout:
Docs
v2/v1maintenance branches (1.x row added)UPGRADE.mdgains the 1.x → 2.0 section, so the full upgrade path (1 → 2 → 3) is discoverable frommain, and a 3.0 → 3.1 section documenting the default-on redactionvendor:publishsnippets use a quoted, single-backslash provider argument (portable across shells)Tests
tests/Unitandtests/Feature(Laravel convention) with separate PHPUnit testsuites; namespaces follow the directoriesRedactorTestparent import aliased toPHPUnitTestCasefor clarityFixes
This fixes #15 (main part; #16 covers the
v1branch — ideally merge that first, since merging this PR auto-closes the issue).