-
Notifications
You must be signed in to change notification settings - Fork 24
Update readme file to prevent confusions with apikey in configuration class #409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @RodrigoSosa95, 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 addresses a potential source of confusion in the project's documentation by clarifying how API authentication tokens should be configured. The primary goal is to improve the developer experience by making the setup process more intuitive and less prone to common misconfigurations.
Highlights
- Documentation Clarity: Updated the README.md file to replace the misleading "apikey" variable name with "accessToken" in the configuration example, aligning it with the actual parameter name.
- Preventing Configuration Errors: This change aims to prevent common user confusion and errors when setting up the API client, as highlighted by the author's own experience.
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 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
-
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.
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 updates the example code in the README to use accessToken as the variable name for the access token, which improves clarity by matching the Configuration class's property name. This is a good change that will help prevent confusion for new users. I've added one suggestion to make the example even more concise by using modern JavaScript syntax.
| const apikey = "key_xxxxx"; | ||
| const config = new Configuration({ accessToken: apikey }); | ||
| const accessToken = "key_xxxxx"; | ||
| const config = new Configuration({ accessToken: accessToken }); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for improving the clarity of this example. As you mentioned in the pull request description, we can use property shorthand here. This will make the code even more concise and idiomatic.
| const config = new Configuration({ accessToken: accessToken }); | |
| const config = new Configuration({ accessToken }); |
Description
I spent a couple of hours trying to figure out why my requests were failing, turns out I used
apikeyinstead of accessToken in the configuration class and passed the private key from my admin dashboard. this is confusing since we can now have short hand property assignments like.Tested scenarios
N/A
Fixed issue:
??