Prepare for dotorg directory release #6
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @westonruter, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on preparing the plugin for release on the WordPress.org plugin directory. It introduces an automated process to generate the required readme.txt file from the existing README.md, along with necessary adjustments to plugin metadata and repository configuration to facilitate a smooth release.
Highlights
- Automated Readme Generation: Introduced a new PHP script (
tools/transform-readme.php) and a correspondingnpmscript (transform-readme) to automatically convert theREADME.mdfile into thereadme.txtformat required for the WordPress.org plugin directory. This script handles metadata extraction, short description placement, screenshot captioning, and Markdown heading conversion. - Plugin Metadata Adjustments: Updated the
README.mdfile to reorder and re-format plugin metadata (Contributors, Tags, Tested up to, Stable tag, License) to align with WordPress.org standards. The short description was also moved to the top of the file. Additionally, theUpdate URIheader was removed fromnocache-bfcache.php, as it's not needed for plugins hosted on WordPress.org. - Git Ignore Update: Added
readme.txtto the.gitignorefile to prevent the generated file from being committed to the repository, ensuring that it is always generated fresh for releases.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request prepares the plugin for release on the WordPress.org directory. It updates the readme, adds a build script to generate the readme.txt file required by WordPress.org, and adjusts plugin headers and .gitignore. The review focuses on improving the robustness and correctness of the new transform-readme.php build script and removing a duplicate entry in .gitignore.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request prepares the plugin for release on the WordPress.org directory. It includes updates to documentation (README.md), build scripts, and configuration files to align with wordpress.org standards. A new tool to transform README.md to readme.txt is also introduced.
My review found a couple of issues:
- A critical syntax error in a
package.jsonscript that will cause it to fail. - An inefficient and non-standard way of loading CSS in a PHP file, for which I've recommended using the standard WordPress enqueueing mechanism.
Once these are addressed, the changes look good and should achieve the goal of preparing for the release.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
westonruter
force-pushed
the
prepare/dotorg
branch
from
a574927 to
f473d51
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
The pull request prepares the plugin for a dotorg directory release. Changes include updates to .gitignore, README.md, composer.json, composer.lock, lint-staged.config.js, nocache-bfcache.php, package.json, phpcs.xml.dist, stylelint.config.js, tools/phpcs/plugin-check.ruleset.xml, and tools/transform-readme.php. The changes primarily focus on improving code quality, adding new linting rules, enhancing the login form, and updating the readme transformation process.
No description provided.