Update README.md for improved structure and clarity#97
Update README.md for improved structure and clarity#97wenakanew wants to merge 2 commits intogoogle-gemini:mainfrom
Conversation
Summary of ChangesHello @wenakanew, 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 significantly overhauls the Highlights
Changelog
Activity
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 provides a significant and valuable overhaul of the README.md file, making it much more structured, comprehensive, and user-friendly. The new sections on repository structure, included features, and language-specific quickstarts are excellent additions. I've provided a few suggestions to further improve clarity and consistency in the quickstart instructions and to align with standard practices for some of the languages.
README.md
Outdated
| @@ -1,31 +1,249 @@ | |||
| # Gemini API examples | |||
| # **Gemini API Examples** | |||
There was a problem hiding this comment.
The use of bold markdown (**) inside a level-1 heading is redundant and non-standard. The # character already creates a top-level heading, which browsers and markdown renderers typically display as large and bold. For cleaner and more standard markdown, the asterisks should be removed.
| # **Gemini API Examples** | |
| # Gemini API Examples |
README.md
Outdated
| ### Set Up | ||
|
|
||
| 1. Open the folder in IntelliJ IDEA | ||
| 2. Load Maven when prompted (`pom.xml`) | ||
| 3. Wait for dependencies to download | ||
|
|
||
| ### Set API Key | ||
|
|
||
| Set `GOOGLE_API_KEY` in your Run/Debug environment variables. |
There was a problem hiding this comment.
The setup and API key instructions for Java are quite specific to IntelliJ IDEA. To make them more broadly applicable to users of other IDEs or the command line, consider:
- Generalizing the setup steps for any Maven project.
- Providing the
export GOOGLE_API_KEY=...command for setting the API key, for consistency with the other language sections.
For example, you could rephrase the setup to be about opening a Maven project in a 'preferred IDE', and add the export command to the API key section.
| ```bash | ||
| node <feature>.test.js | ||
| ``` |
There was a problem hiding this comment.
Running tests by directly invoking the test file with node is unconventional for a JavaScript project. Typically, a test runner like Jest, Mocha, or the built-in Node.js test runner is used, invoked via a script in package.json (e.g., npm test). This provides better test reporting and aligns with standard JS development practices. Consider updating the project to use a standard test runner and changing this instruction to npm test.
All Reviewer Feedback Addressed — README UpdatedI've addressed all the feedback points: 1. Removed bold formatting from the top-level headerReplaced the non-standard: # **Gemini API Examples**with the cleaner and conventional: # Gemini API Examples2. Generalized and improved Java setup instructionsUpdated the Java section to be IDE-agnostic and more consistent with other languages:
This makes the instructions more portable across IDEs and command-line workflows. ✔️ 3. Updated JavaScript test instructions to recommended practicesThe project now uses
npm test
This aligns with standard JavaScript conventions and improves the contributor experience. 4. Cleaned up Python installation instructionsRemoved Updated installation: pip install absl-py google-genai PillowFormatting instructions remain in their proper section. 5. Additional README improvementsWhile implementing the requested changes, I also:
The README is now more structured, clearer for beginners, and aligned with common development practices. |
All Reviewer Feedback Addressed — README UpdatedI've addressed all the feedback points: 1. Removed bold formatting from the top-level headerReplaced the non-standard: # **Gemini API Examples**with the cleaner and conventional: # Gemini API Examples2. Generalized and improved Java setup instructionsUpdated the Java section to be IDE-agnostic and more consistent with other languages:
This makes the instructions more portable across IDEs and command-line workflows. 3. Updated JavaScript test instructions to recommended practicesThe project now uses
npm test
This aligns with standard JavaScript conventions and improves the contributor experience. 4. Cleaned up Python installation instructionsRemoved Updated installation: pip install absl-py google-genai PillowFormatting instructions remain in their proper section. 5. Additional README improvementsWhile implementing the requested changes, I also:
The README is now more structured, clearer for beginners, and aligned with common development practices. |
1 participant
This pull request significantly expands and improves the
README.mdto provide a much more comprehensive, beginner-friendly, and structured guide to the Gemini API examples repository. The new README clarifies the repository's purpose, details its structure, explains the scope of included examples, and adds clear quickstart and contribution instructions for each supported language.Repository documentation improvements:
Best practices and contribution guidance: