docs: update stale example placeholders in the bug report issue template - #232
Merged
Merged
Conversation
The bug report template's example placeholders were left over from an old release: "Package Version" suggested 2.0.0 and "Laravel Version" suggested 9.0.0. Per the README's Requirements section and CHANGELOG.md, only Laravel 11.x/12.x are supported as of v2.0.0, and the package is well past 2.0.0 now. A reporter skimming the placeholders could reasonably infer those old, unsupported versions were still current examples, leading to confusing bug reports or reporters second-guessing their own (correct) version numbers. Update the placeholders to 3.1.2 and 12.0.0 to reflect current reality. Fixes #155
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
1 participant
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.
What was broken
.github/ISSUE_TEMPLATE/bug.yml's example placeholders were stale leftovers from an old release:2.0.09.0.0Per the README's Requirements section and
CHANGELOG.md, only Laravel 11.x/12.x are supported as of v2.0.0, and the package's current release is well past2.0.0(v3.1.2perCHANGELOG.md). A reporter skimming the placeholder text could reasonably (if incorrectly) infer that2.0.0/ Laravel9.0.0are still current/in-scope examples, leading to confusing bug reports against unsupported combinations, or reporters second-guessing whether their own correct, current version numbers "look right" next to the example.What changed
2.0.0to3.1.2.9.0.0to12.0.0(within the currently supported 11.x/12.x range).tests/Unit/BugReportTemplateTest.php, a regression test that asserts the template no longer suggests the old2.0.0/9.0.0examples and that the Laravel version placeholder stays within the supported11.x/12.xrange.Fixes #155
Testing
vendor/bin/pint --dirty— no style issuescomposer test— full suite passes (253 tests, 634 assertions)