Add Docker as dependency to developer guide#2331
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @gramian, 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 updates the developer guide to explicitly include Docker as a necessary dependency. This change ensures that developers are aware of the requirement for Docker, which is essential for running end-to-end tests.
Highlights
- Documentation Update: Added Docker to the list of required development dependencies in the
CONTRIBUTING.mdguide.
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
-
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 adds Docker as a dependency to the developer guide. My review suggests a small improvement to the description to make it more comprehensive for new contributors by mentioning that Docker is used for both building images and running end-to-end tests.
|
|
||
| - **Java v21** for the runtime or major | ||
| - [**Apache Maven**](https://maven.apache.org/), to build the distribution | ||
| - [**Docker**](https://www.docker.com/), to build the container images |
There was a problem hiding this comment.
Thanks for adding this dependency. The PR description mentions that Docker is needed for end-to-end tests, which is a very important piece of information for developers. The current text only mentions building container images. To provide a more complete picture for new contributors, it would be beneficial to mention both purposes.
| - [**Docker**](https://www.docker.com/), to build the container images | |
| - [**Docker**](https://www.docker.com/), to build container images and run end-to-end tests |
|
Thanks! |
What does this PR do?
Add a note to the developer guide about Docker as dependency
Motivation
Docker is needed for e2e tests.
Checklist
mvn clean packagecommand