meta: add GitHub issue templates for bugs, features, and docs#411
meta: add GitHub issue templates for bugs, features, and docs#411anshul-garg27 wants to merge 3 commits intogoogleworkspace:mainfrom
Conversation
Add structured YAML form templates to `.github/ISSUE_TEMPLATE/` for consistent, actionable issue reports: - bug_report.yml — version, OS, reproduction steps, expected vs actual - feature_request.yml — problem, proposed solution, area selector - docs_improvement.yml — document location, what's wrong, suggestion - config.yml — link to security policy, allow blank issues Closes googleworkspace#400
🦋 Changeset detectedLatest commit: c67060f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Summary of ChangesHello, 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 significantly enhances the repository's issue management by introducing structured GitHub issue templates. The goal is to streamline the reporting process for bugs, feature requests, and documentation improvements, ensuring that all submissions are consistent and contain the necessary information for efficient triage. This change is particularly beneficial for AI agents interacting with the CLI, as it provides reliable input formats, ultimately improving the overall maintainability and responsiveness of the project. Highlights
Changelog
Activity
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces GitHub issue templates for bug reports, feature requests, and documentation improvements, which will help standardize issue reporting. The changes are well-structured. I have one suggestion to improve the security vulnerability reporting process by making the contact link point directly to the vulnerability intake form, which will make it easier and faster for security researchers to report issues.
.github/ISSUE_TEMPLATE/config.yml
Outdated
| url: https://github.com/googleworkspace/cli/blob/main/SECURITY.md | ||
| about: Report security vulnerabilities through our security policy |
There was a problem hiding this comment.
For a more direct and user-friendly process, the contact link for security vulnerabilities should point directly to the reporting page mentioned in SECURITY.md (https://g.co/vulnz) instead of the SECURITY.md file itself. This reduces the number of steps for the reporter and ensures they land on the correct intake form immediately, which is crucial for timely handling of security issues.
url: https://g.co/vulnz
about: Report security vulnerabilities via Google's vulnerability intake form.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces a set of GitHub issue templates for bug reports, feature requests, and documentation improvements. These templates are well-designed and will help in receiving structured and actionable issue reports. My review includes one high-severity suggestion for the config.yml file to improve the security vulnerability reporting workflow by linking directly to the intake form, which will make the process more efficient and secure for reporters.
.github/ISSUE_TEMPLATE/config.yml
Outdated
| - name: Security Vulnerability | ||
| url: https://github.com/googleworkspace/cli/blob/main/SECURITY.md | ||
| about: Report security vulnerabilities through our security policy |
There was a problem hiding this comment.
The contact link for security vulnerabilities points to the SECURITY.md file. This adds an extra step for the user, as they have to navigate to that file and then click another link to report a vulnerability. To streamline this process and reduce the risk of accidental public disclosure, it's better to link directly to the vulnerability intake form. The SECURITY.md file itself indicates that https://g.co/vulnz is the correct place for reporting.
- name: Security Vulnerability
url: https://g.co/vulnz
about: Report security vulnerabilities via Google's vulnerability intake form.Address review feedback: point the security vulnerability contact link to https://g.co/vulnz (the intake form) instead of the SECURITY.md file, making it faster for reporters to submit vulnerabilities.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces well-structured GitHub issue templates for bug reports, feature requests, and documentation improvements, which will improve the consistency of issue reports. The templates are well-designed. My only suggestion is to disable blank issues in config.yml to ensure these new templates are always used, maximizing their benefit and aligning with the goal of structured reporting.
| @@ -0,0 +1,5 @@ | |||
| blank_issues_enabled: true | |||
There was a problem hiding this comment.
The goal of this PR is to ensure consistent, actionable issue reports via structured templates. However, setting blank_issues_enabled: true allows users to bypass them, which undermines this goal. To maximize the benefit of these new templates, especially for AI agents that rely on structured input as mentioned in the PR description, I recommend disabling blank issues. This will enforce the use of the templates for all new issues.
blank_issues_enabled: false2 participants
Summary
.github/ISSUE_TEMPLATE/for consistent, actionable issue reportsconfig.ymlwith link to security policy and blank issues enabledTemplates
bugenhancementarea: docsWhy
The repo currently has a PR template but no issue templates. Structured forms ensure consistent reports and make triage easier — especially important since this CLI is used by AI agents that benefit from reliable input formats.
Test plan
config.ymllinks to SECURITY.md and allows blank issuesCloses #400