Skip to content

Pull request template for Java#866

Open
ryanaiagent wants to merge 1 commit intogoogle:mainfrom
ryanaiagent:doc/pull_request_template
Open

Pull request template for Java#866
ryanaiagent wants to merge 1 commit intogoogle:mainfrom
ryanaiagent:doc/pull_request_template

Conversation

@ryanaiagent
Copy link

Pull request template for java similar to the template used in adk-python

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ryanaiagent, 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 introduces a standardized pull request template for Java projects. The template aims to streamline the PR submission process by providing clear sections for linking issues, describing changes, outlining testing plans, and including a comprehensive checklist. This initiative helps ensure consistency and thoroughness in contributions, similar to practices established in related repositories.

Highlights

  • New Pull Request Template: A new pull request template has been added for Java projects, mirroring the structure and content of the template used in the adk-python repository.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • .github/pull_request_template.md
    • Added a new pull request template to guide contributors through the PR submission process.
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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 introduces a template for pull requests to standardize their format, which is a great addition. I've suggested a couple of minor improvements to the template to enhance clarity and enforce repository contribution rules more effectively. Specifically, I've recommended updating a link to point to the repository-specific contribution guide and adding a checklist item for the single-commit policy.

@@ -0,0 +1,52 @@
**Please ensure you have read the [contribution guide](https://google.github.io/adk-docs/contributing-guide/) before creating a pull request.**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link to the contribution guide points to a general ADK documentation page. For better consistency and to ensure contributors see repository-specific guidelines, it's better to link to this repository's CONTRIBUTING.md file, similar to the link in the checklist.

Suggested change
**Please ensure you have read the [contribution guide](https://google.github.io/adk-docs/contributing-guide/) before creating a pull request.**
**Please ensure you have read the [contribution guide](https://github.com/google/adk-java/blob/main/CONTRIBUTING.md) before creating a pull request.**


### Checklist

- [ ] I have read the [CONTRIBUTING.md](https://github.com/google/adk-java/blob/main/CONTRIBUTING.md) document.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The CONTRIBUTING.md file states that pull requests must contain only a single commit. This is a critical requirement for this repository. To help contributors adhere to this rule, consider adding an explicit item to the checklist.

Suggested change
- [ ] I have read the [CONTRIBUTING.md](https://github.com/google/adk-java/blob/main/CONTRIBUTING.md) document.
- [ ] I have read the [CONTRIBUTING.md](https://github.com/google/adk-java/blob/main/CONTRIBUTING.md) document.
- [ ] My pull request contains a single commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant