docs: Add supported PHP versions section to the README #6768
Conversation
bocharsky-bw
changed the title
| ## Supported versions | ||
| * PHP 7.4 | ||
| * PHP 8.0 | ||
| * PHP 8.1 |
There was a problem hiding this comment.
I wonder if we can put some guard (eg in tests/AutoReview/) to make sure that this list is up to date ?
There was a problem hiding this comment.
Hm, it would be cool, I'll try to look at it
There was a problem hiding this comment.
I think 7910bf5 should be enough to notice any change in supported PHP versions
Pull Request Test Coverage Report for Build 4366992768
💛 - Coveralls |
README.md
Outdated
| > NOTE: Each new PHP version requires a huge effort to support the new syntax. | ||
| > That's why the latest PHP version might not be supported yet. If you need it, | ||
| > please, consider supporting the project in any convenient way, for example | ||
| > with code contribution or reviewing existing RPs. |
There was a problem hiding this comment.
perhaps use GitHub note feature?
Note
foobar foo baz
What about also, as it is main readme new section of Supported PHP Versions
adding something telling that it can be run on new PHP version but "at own risk" leveraging PHP_CS_FIXER_IGNORE_ENV=1 ?
this paragraph alone may stop ppl using/testing/running on newer version
as it is require to manually do something to run it, I may think it is ok for dev
wdty?
There was a problem hiding this comment.
@94noni I like both suggestions and pushed changes to apply them, thanks!
There was a problem hiding this comment.
Since the information will be in README.md then we could have it removed from usage page.
There was a problem hiding this comment.
Actually, I just mention it, but a more detailed explanation is still in the usage section. I think we should just link to it instead of copy/paste everything in the README
There was a problem hiding this comment.
Who said anything about copy/pasting? I've suggested moving it, link is also fine.
|
@keradus Does it look better for you now? |
Co-authored-by: Kuba Werłos <werlos@gmail.com>
Co-authored-by: Kuba Werłos <werlos@gmail.com>
Co-authored-by: Grzegorz Korba <wirone@gmail.com>
Co-authored-by: Grzegorz Korba <wirone@gmail.com>
I hope it will help with discovering supported versions better and prevent creating issues.
Ref: #6764 (comment)