Code style guidance and PR template

[zhaochenyang20]

As titled. Following our rules.

[gemini-code-assist]

Summary of Changes

Hello @zhaochenyang20, I'm Gemini Code Assist¹! 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 introduces foundational documentation to enhance code quality and streamline the development workflow. It establishes a clear pull request template to standardize submission information and provides a comprehensive code style guide to ensure consistency, performance, and maintainability across the codebase.

Highlights

• Pull Request Template: A new pull request template has been added to guide contributors in providing comprehensive information for their changes, including sections for description, code style compliance, testing, and a checklist.
• Code Style Guide: A detailed code style guide has been introduced, covering best practices for performance, architecture, function purity, Pythonic code, and testing efficiency, to ensure consistent and high-quality contributions.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

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]

Code Review

This pull request introduces a pull request template and a code style guide, which are great additions for standardizing contributions. My review focuses on improving the correctness of links in the PR template and minor formatting issues in the code style guide. Specifically, the relative links in the PR template are likely broken and need to be adjusted to be relative to the repository root. Additionally, the code style guide has a minor trailing whitespace issue and is missing a final newline character.

[zhaochenyang20]

@PopSoda2002 needs your comments

[PopSoda2002]

Thanks for the work! I think there are still some style should be added in the future, stay tunned

[PopSoda2002]

LGTM!

[PopSoda2002]

Can I know what is hot paths exactly?