wp-media / imagify-plugin

Speed up your website with lighter images without losing quality.

https://imagify.io

73 stars 26 forks source link

Enhancement/readme update august 2024 makreting #896

Closed MathieuLamiot closed 2 months ago

MathieuLamiot commented 2 months ago

Description

Applies the changes highlighted in yellow from this file to the readme.txt: https://docs.google.com/document/d/1zkGwSShnHvNNDjg7xXMLzvZcCWUxEstrtSMDTyQPIIo/edit

Type of change

[ ] New feature (non-breaking change which adds functionality).
[ ] Bug fix (non-breaking change which fixes an issue).
[x] Enhancement (non-breaking change which improves an existing functionality).
[ ] Breaking change (fix or feature that would cause existing functionality to not work as before).
[ ] Sub-task of #(issue number)
[ ] Release

Detailed scenario

NA

Technical description

Documentation

NA

New dependencies

NA

Risks

NA

Mandatory Checklist

Code validation

[x] I validated all the Acceptance Criteria. If possible, provide screenshots or videos.
[x] I triggered all changed lines of code at least once without new errors/warnings/notices.
[x] I implemented built-in tests to cover the new/changed code.

Code style

[x] I wrote a self-explanatory code about what it does.
[x] I protected entry points against unexpected inputs.
[x] I did not introduce unnecessary complexity.
[x] Output messages (errors, notices, logs) are explicit enough for users to understand the issue and are actionnable.

Additional Checks

[ ] In the case of complex code, I wrote comments to explain it.
[ ] When possible, I prepared ways to observe the implemented system (logs, data, etc.).
[ ] I added error handling logic when using functions that could throw errors (HTTP/API request, filesystem, etc.)