Hello @jbampton, 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
This pull request adds a .codespellrc configuration file to standardize codespell settings and updates the .pre-commit-config.yaml file to remove the inline ignore-words argument, leveraging the new config file instead. This makes it easier to run codespell from the command line and ensures consistent configuration across different environments.
Highlights
- Configuration: Adds a
.codespellrcfile to define codespell configuration. - Pre-commit Hook: Modifies
.pre-commit-config.yamlto use the.codespellrcfile instead of inline arguments. - Command Line Usage: Enables running codespell from the command line with the standard configuration.
Changelog
- .codespellrc
- Added a new file to specify codespell configuration, including ignored words and skipped directories.
- .pre-commit-config.yaml
- Removed the
ignore-wordsargument from the codespell hook, as the configuration is now handled by.codespellrc.
- Removed the
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.
A config file's grace,
Codespell finds its place,
No arguments long,
Just righting the wrong,
With standards to embrace.
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. โฉ