Update bug report template, add env capture tools #1656
Conversation
Signed-off-by: Kyle Sayers <kylesayrs@gmail.com>
|
👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review. Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @kylesayrs, 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 improves the bug reporting workflow by introducing a modern, structured issue template and a utility script for automated environment information collection. My goal is to make it easier for users to submit comprehensive bug reports, which in turn will help us diagnose and resolve issues more efficiently.
Highlights
- Bug Report Template Revamp: I've completely updated the
bug_report.mdtemplate to leverage GitHub's new issue form features. This provides a more structured and user-friendly experience for reporting bugs, including dedicated fields for bug descriptions and reproduction steps, and a new section for automated environment information. - Automated Environment Collection Tool: I've added a new Python script,
tools/collect_env.py, designed to automatically gather essential environment details. This script will help users quickly provide information such as their operating system, Python version, and versions of key libraries likellm-compressor,compressed-tensors,transformers, andtorch, as well as detected CUDA and AMD devices, streamlining the bug reporting 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 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 introduces a new issue form for bug reports and a helper script to collect environment information. The changes are a significant improvement for issue tracking. My review includes suggestions to fix a broken link in the issue template and to enhance the environment collection script for better robustness and more comprehensive debugging information.
Signed-off-by: Kyle Sayers <kylesayrs@gmail.com>
Purpose
Changes