Updated documentation for “scaffold package-readme.” #272
Conversation
The edit is in accordance with discussion at wp-cli#270.
|
Hello! 👋 Thanks for opening this pull request! Please check out our contributing guidelines. We appreciate you taking the initiative to contribute to this project. Contributing isn't limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation. Here are some useful Composer commands to get you started:
To run a single Behat test, you can use the following command: # Run all tests in a single file
composer behat features/some-feature.feature
# Run only a specific scenario (where 123 is the line number of the "Scenario:" title)
composer behat features/some-feature.feature:123You can find a list of all available Behat steps in our handbook. |
Summary of ChangesHello @baizmandesign, 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 enhances the documentation for the Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds important information to the scaffold package-readme command's documentation, clarifying that the package needs to be loaded by WP-CLI for the command to function correctly. This is a helpful addition for users.
I've left a couple of minor suggestions to improve formatting and maintain consistency with the project's style. The use of **Important:** is appropriate to draw attention to this prerequisite.
Thank you for this contribution!
| * ``` | ||
| * | ||
| * **Important:** for the `package-readme` subcommand to work properly, your | ||
| * package must be loaded by WP CLI. You may load your package in one of two |
There was a problem hiding this comment.
For consistency with the rest of the project's documentation and the WP-CLI brand, WP CLI should be written as WP-CLI.
* package must be loaded by WP-CLI. You may load your package in one of two
src/ScaffoldPackageCommand.php
Outdated
| * ``` | ||
| * require: | ||
| * - your-package.php | ||
| * ``` |
There was a problem hiding this comment.
This line has inconsistent indentation (using spaces instead of a tab). Please correct the formatting to match the surrounding lines for better readability and to avoid potential rendering issues.
* ```
| * | ||
| * ``` | ||
| * require: | ||
| * - your-package.php |
There was a problem hiding this comment.
| * - your-package.php | |
| * - your-package.php |
| * ways: | ||
| * | ||
| * * install the package locally (e.g., from the filesystem via `wp package install /path/to/package`) | ||
| * * add a `wp-cli.yml` file in your project directory requiring your package. Here's an example: |
There was a problem hiding this comment.
a third way would be to manually do --require=path/to/package
|
Thank you! I hope to find some time to fix the underlying issue and throw a proper error (or just make it work), then we can cut down the documentation a little bit. |
2 participants
The edit is in accordance with discussion at #270.
@swissspidy A couple of brief notes about this PR: