Remove init-script from readme #1562
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @mlykotom, 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!
Summary of Changes
Hello! Gemini here, providing a summary of this pull request. This PR, authored by mlykotom, aims to clean up the documentation by removing an unnecessary flag from the gradlew commands used for running Spotless on individual samples. The --init-script buildscripts/init.gradle.kts flag is no longer required for these specific tasks, simplifying the instructions for users.
Highlights
- Documentation Update: The primary change is an update to the
README.mdfile, specifically in the 'Formatting' section. - Simplify Spotless Commands: The
--init-script buildscripts/init.gradle.ktsflag has been removed from thegradlew spotlessCheckandgradlew spotlessApplycommands listed for checking/formatting single samples, making the commands shorter and simpler.
Changelog
- README.md
- Removed the
--init-script buildscripts/init.gradle.ktsflag from the command to check a single sample for Spotless errors (line 79). - Removed the
--init-script buildscripts/init.gradle.ktsflag from the command to format a single sample using Spotless (line 80).
- Removed the
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.
Old flag is removed,
Commands are now short and sweet,
Docs are clean and clear.
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
This pull request simplifies the Gradle commands in the README.md for running Spotless checks and applying formatting to individual samples. By removing the --init-script buildscripts/init.gradle.kts argument, the instructions are now more concise and easier to follow.
This change appears to be well-justified, as the Spotless plugin and its configuration are now applied to subprojects directly from the root JetLagged/build.gradle.kts file. This centralization makes the explicit init script redundant for commands executed within individual sample directories.
Well done on this simplification! It improves the developer experience when working with individual samples.
Summary of Findings
- Potential for Further Simplification in Related Scripts: The
scripts/format.shscript (line 27:./scripts/gradlew_recursive.sh --init-script buildscripts/init.gradle.kts spotlessApply) still utilizes the--init-scriptargument. Given that the Spotless configuration has been centralized in the rootbuild.gradle.kts(applying to subprojects), it's worth investigating if this--init-scriptargument can also be removed fromscripts/format.shfor consistency and to fully deprecate reliance on the init script for Spotless. This is alowseverity observation concerning overall project consistency. As per review settings, a direct comment was not made as this file is not part of the current diff and the observation is of low severity.
Merge Readiness
The changes in this pull request are clear, correct, and improve the documentation. The simplification of the README commands is a welcome improvement. I believe this PR is ready to be merged. As a reviewer, I am not authorized to approve the pull request, so please ensure it undergoes any further necessary review and approval processes before merging.
No description provided.