Make pr-template easier to use #2
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @PieterjanDeClippel, 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
Hello! Gemini here, providing a summary of this pull request. This PR, authored by PieterjanDeClippel, aims to make the pull request template easier to use. The primary change involves simplifying the section dedicated to linking related issues within the .github/PULL_REQUEST_TEMPLATE.md file. The goal is to streamline the process for authors when referencing issues connected to their changes.
Highlights
- Simplify PR Template: The main focus of this pull request is to simplify the standard pull request template file (
.github/PULL_REQUEST_TEMPLATE.md). - Easier Issue Linking: Specifically, the 'Related Tickets & Documents' section has been updated. The previous detailed, commented-out instructions on how to link issues have been removed and replaced with a simple, ready-to-use placeholder:
- Closes #.
Changelog
- .github/PULL_REQUEST_TEMPLATE.md
- Removed lengthy commented-out instructions for linking issues.
- Replaced instructions with a concise
- Closes #placeholder to facilitate quicker issue linking.
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.
Template made quite clean,
Link issues, simple task now,
Ready for review.
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. ↩
|
It appears this pull-request does not have an issue. Thank you. |
There was a problem hiding this comment.
Code Review
This PR aims to simplify the pull request template, specifically the 'Related Tickets & Documents' section, by making it more direct. The change successfully makes this section visually cleaner by removing the HTML comment block. My main feedback focuses on ensuring that this simplification doesn't inadvertently remove too much helpful guidance for contributors. Please see the specific comment for a suggestion.
Summary of Findings
- Balancing Simplicity and Guidance in PR Template: The change to the 'Related Tickets & Documents' section simplifies its appearance but removes a helpful link to GitHub documentation and examples for linking issues. This could make it harder for some contributors to use the feature optimally. A suggestion is provided to offer a concise line that includes keyword examples and a documentation link.
Merge Readiness
The goal of simplifying the PR template is appreciated, and the current change does make the 'Related Tickets & Documents' section visually less cluttered. However, there's a suggestion to refine this section to retain important guidance on issue linking while still being more concise than the original HTML comment. I recommend considering this feedback to ensure the template remains as helpful as possible for all contributors. As I am an AI, I cannot approve this PR; please ensure it is reviewed and approved by a human maintainer before merging.
| Please use this format link issue numbers: Fixes #123 | ||
| https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword | ||
| --> | ||
| - Closes # |
There was a problem hiding this comment.
This change definitely makes the template visually cleaner by removing the HTML comment block, which is a good step towards making it easier to use at first glance!
However, by removing the previous example format (e.g., Fixes #123) and the direct link to the GitHub documentation, we might be losing some valuable guidance. This information can be particularly helpful for newer contributors or those less familiar with all the available issue linking keywords (Closes, Fixes, Resolves, etc.) and how to link multiple issues effectively.
While - Closes # is very direct, it's a bit prescriptive (focusing only on Closes) and doesn't guide users to learn more if they need to. The original link provided comprehensive information on this GitHub feature.
What are your thoughts on a middle ground that keeps the section concise but retains the essential guidance? For example, something like the suggestion below, which is still a single line and not hidden in a comment, but offers more flexibility and a path to further information:
| - Closes # | |
| - Link issues using keywords like Closes #, Fixes #, Resolves #. [More info](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) |
2 participants
What type of PR is this? (check all applicable)
Description
Related Tickets & Documents
Screenshots/Recordings
Checklist
Added to documentation?
[optional] Are there any post-deployment tasks we need to perform?