chore: Update Codespaces to use copilot#159
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @toby-coleman, 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 integrates GitHub Copilot into the Codespaces development environment, making the AI-powered coding assistant available to developers. It also updates the project's contributing guidelines to include instructions and recommendations for using Copilot, particularly for generating example models.
Highlights
- Codespaces Configuration: Enabled GitHub Copilot and Copilot Chat extensions within the Codespaces development environment by updating
.devcontainer/devcontainer.json. - Documentation Update: Added a new section to
CONTRIBUTING.mdproviding guidance on using GitHub Copilot, specifically for building example models with a custom LLM prompt.
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.
Code Review
This pull request enables GitHub Copilot for Codespaces by updating the devcontainer.json configuration and adds guidance on using Copilot in CONTRIBUTING.md. The changes are straightforward and align with the goal of improving the development experience. I've provided one comment on the new documentation in CONTRIBUTING.md to suggest clarifications that would make the guidance more actionable and less confusing for contributors.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Summary
Copilot is now enabled when working in Github codespaces.
Changes
CONTRIBUTING.mdto include guidance on Copilot usage.