-
Notifications
You must be signed in to change notification settings - Fork 2
Create the initial .github/PULL_REQUEST_TEMPLATE.md for this repo
#83
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
Conversation
Now consistent with the Flutter IJ repo. Related PR: flutter/flutter-intellij#8614
Summary of ChangesHello @jwren, 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 the repository. The primary goal is to streamline the PR submission process by providing clear guidelines and a consistent structure for descriptions, ensuring that all necessary information is provided upfront. This change aims to improve the efficiency of reviews and maintain a high standard for contributions. Highlights
Using Gemini Code AssistThe 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
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 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
|
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 introduces a pull request template, which is a great step towards standardizing contributions. The template is well-structured, but I've identified a few areas for improvement. Specifically, there's a broken markdown link that needs fixing, and a couple of minor formatting adjustments that will enhance the template's readability and correctness. My suggestions address these points to ensure the template is effective for all contributors.
| <details> | ||
| <summary>Contribution guidelines:</summary><br> | ||
|
|
||
| - See our [contributor guide]([https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md) for general expectations for PRs. |
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.
The markdown syntax for the link to the contributor guide is incorrect due to nested link syntax [text]([url](url)). This will result in a broken link in the rendered pull request description. It should be corrected to the standard [text](url) format.
| - See our [contributor guide]([https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md) for general expectations for PRs. | |
| - See our [contributor guide](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md) for general expectations for PRs. |
| @@ -0,0 +1,14 @@ | |||
| - Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below. | |||
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.
The introductory text is formatted as a list item due to the leading -. It would be more appropriate as a regular paragraph for better readability.
| - Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below. | |
| Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below. |
| - [ ] I’ve reviewed the contributor guide and applied the relevant portions to this PR. | ||
|
|
||
| <details> | ||
| <summary>Contribution guidelines:</summary><br> |
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.
The <br> tag after the <summary> is unnecessary and not standard practice. A blank line after the <summary> tag is sufficient to start the content of the <details> block on a new line, and is cleaner.
| <summary>Contribution guidelines:</summary><br> | |
| <summary>Contribution guidelines:</summary> |
Now consistent with the Flutter IJ repo. Related PR: flutter/flutter-intellij#8614