Skip to content

[Docs] fix contributors graph - #37

Merged
Wangmerlyn merged 2 commits into
mainfrom
docs/fix-contributor-graph
Jul 21, 2025
Merged

[Docs] fix contributors graph#37
Wangmerlyn merged 2 commits into
mainfrom
docs/fix-contributor-graph

Conversation

@Wangmerlyn

Copy link
Copy Markdown
Owner

No description provided.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @Wangmerlyn, 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 improving the project's documentation quality and consistency. It addresses a specific styling issue within the README.md related to the contributors graph and introduces a new pre-commit hook to automate markdown table of contents management.

Highlights

  • Documentation Styling Fix: The README.md file has been updated to include <!-- google-doc-style-ignore --> and <!-- google-doc-style-resume --> comments around the contributors graph image. This change ensures that the image section is bypassed by the google-doc-style checker, resolving potential styling conflicts or errors.
  • Pre-commit Hook Addition: A new markdown-toc hook has been added to the .pre-commit-config.yaml file. This hook, part of the google/yapf repository, will likely help in maintaining or generating tables of contents for markdown files, further enhancing documentation quality.
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

  1. 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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request aims to fix the contributors graph display in the README.md by adding ignore comments for the check-google-doc-style pre-commit hook. This is a reasonable fix. The PR also introduces a new markdown-toc pre-commit hook. While this hook can be useful, I've suggested moving it to a separate pull request to keep this one focused on a single logical change, which is a common best practice for code reviews and repository maintenance.

Comment thread .pre-commit-config.yaml
@Wangmerlyn
Wangmerlyn merged commit 5b58bb1 into main Jul 21, 2025
2 of 3 checks passed
@Wangmerlyn
Wangmerlyn deleted the docs/fix-contributor-graph branch July 21, 2025 11:55
@Wangmerlyn Wangmerlyn linked an issue Jul 21, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add docs

1 participant