[TRTLLM-6812][feat] Add standardized GitHub issue templates and disable blank issues #6494
Conversation
|
Note Reviews pausedUse the following commands to manage reviews:
📝 WalkthroughWalkthroughA comprehensive set of GitHub issue templates has been introduced to standardize reporting and discussion for documentation, installation, usage, bug reports, CI failures, feature requests, new model support, performance, and RFCs. Additionally, blank issues are disabled and a contact link to discussions is provided. No code or exported entities are affected. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
@coderabbitai pause |
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (7)
.github/ISSUE_TEMPLATE/config.yml (1)
1-5: Good baseline; consider expanding “contact_links” for common support channels
The configuration disables blank issues and provides a single Discussions link. Adding other high-traffic channels (e.g., Slack, mailing list, or Discord if they exist) can further reduce “misc” issues..github/ISSUE_TEMPLATE/500-feature-request.yml (1)
1-39: Minor UX polish – explicitly mark optional fields or add “required: false”
All non-mandatory blocks (Alternatives, Additional context) currently omit avalidations:stanza. GitHub treats them as optional, but addingvalidations: required: falseimproves readability for contributors skimming the raw YAML.
.github/ISSUE_TEMPLATE/750-RFC.yml (1)
1-5: Inconsistent trailing period innamestring
name: 💬 Request for comments (RFC).ends with a period, unlike the other templates. Drop the final “.” to keep the list layout consistent in GitHub’s UI.-name: 💬 Request for comments (RFC). +name: 💬 Request for comments (RFC).github/ISSUE_TEMPLATE/300-usage.yml (1)
13-37: Indentation inside the block literal could be trimmed for cleaner rendered markdown
Thedescription: |block keeps all leading spaces, so the rendered markdown shows extra indentation. Remove the four-space offset after the first line:- description: | - Please provide the following system information to help us debug your usage issue: + description: | +Please provide the following system information to help us debug your usage issue:Same applies to the later “value” block starting at Line 23.
.github/ISSUE_TEMPLATE/200-installation.yml (1)
17-43: Make the system-info block collapsible for readabilityMost other templates wrap long “System Information” dumps inside a
<details>element. Doing the same here keeps issues shorter and scannable while still exposing full logs when expanded.Example diff:
- value: | - **System Information:** + value: | + <details> + <summary>System Information</summary> + + **System Information:** @@ - Paste the output of the above commands here + Paste the output of the above commands here + + </details>.github/ISSUE_TEMPLATE/700-performance-discussion.yml (1)
33-58: Environment block should be mandatory for performance issuesPerformance numbers are meaningless without hardware / software context. Consider setting
required: truefor this textarea..github/ISSUE_TEMPLATE/600-new-model.yml (1)
22-29: Encourage completeness by requiring difficulty analysisKnowing missing ops / architecture gaps upfront helps sizing the work. Add
validations: {required: true}to this field.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
.github/ISSUE_TEMPLATE/100-documentation.yml(1 hunks).github/ISSUE_TEMPLATE/200-installation.yml(1 hunks).github/ISSUE_TEMPLATE/300-usage.yml(1 hunks).github/ISSUE_TEMPLATE/400-bug-report.yml(1 hunks).github/ISSUE_TEMPLATE/450-ci-failure.yml(1 hunks).github/ISSUE_TEMPLATE/500-feature-request.yml(1 hunks).github/ISSUE_TEMPLATE/600-new-model.yml(1 hunks).github/ISSUE_TEMPLATE/700-performance-discussion.yml(1 hunks).github/ISSUE_TEMPLATE/750-RFC.yml(1 hunks).github/ISSUE_TEMPLATE/config.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (5)
.github/ISSUE_TEMPLATE/500-feature-request.yml (2)
Learnt from: CR
PR: NVIDIA/TensorRT-LLM#0
File: CODING_GUIDELINES.md:0-0
Timestamp: 2025-07-30T06:11:42.362Z
Learning: Applies to **/*.{cpp,h,cu,py} : All TensorRT-LLM Open Source Software code should contain an NVIDIA copyright header that includes the current year. This includes .cpp, .h, .cu, .py, and any other source files which are compiled or interpreted.
Learnt from: moraxu
PR: #6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
.github/ISSUE_TEMPLATE/700-performance-discussion.yml (2)
Learnt from: moraxu
PR: #6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
Learnt from: CR
PR: NVIDIA/TensorRT-LLM#0
File: CODING_GUIDELINES.md:0-0
Timestamp: 2025-07-30T06:11:42.362Z
Learning: Applies to **/*.{cpp,h,cu,py} : All TensorRT-LLM Open Source Software code should contain an NVIDIA copyright header that includes the current year. This includes .cpp, .h, .cu, .py, and any other source files which are compiled or interpreted.
.github/ISSUE_TEMPLATE/300-usage.yml (1)
Learnt from: moraxu
PR: #6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
.github/ISSUE_TEMPLATE/750-RFC.yml (1)
Learnt from: CR
PR: NVIDIA/TensorRT-LLM#0
File: CODING_GUIDELINES.md:0-0
Timestamp: 2025-07-30T06:11:42.362Z
Learning: Applies to **/*.{cpp,h,hpp,cc,cxx} : Use the LLVM clang-format tool for formatting your changes prior to submitting the PR.
.github/ISSUE_TEMPLATE/400-bug-report.yml (1)
Learnt from: moraxu
PR: #6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
🔇 Additional comments (3)
.github/ISSUE_TEMPLATE/100-documentation.yml (1)
1-30: Template LGTM – fields, labels, and validation are correct and consistent with other issue types..github/ISSUE_TEMPLATE/300-usage.yml (1)
52-61: LGTM otherwise – thorough prompts ensure reproducible environment details..github/ISSUE_TEMPLATE/400-bug-report.yml (1)
1-123: Template looks solidClear guidance, security warning, and required fields substantially improve bug quality. Nice work.
✅ Actions performedReviews paused. |
|
Thanks @venkywonka for this effort! Personally, I feel like 3 templates (bug, feature request, question) should be more than enough to classify items. Many others can fall into these categories. e.g
etc etc. |
Yep, I used vllm's issue templates as the starting point : https://github.com/vllm-project/vllm/tree/main/.github/ISSUE_TEMPLATE and they had these. |
venkywonka
changed the title
venkywonka
force-pushed
the
add-issue-templates
branch
from
05b0d6f to
33522e5
Compare
venkywonka
force-pushed
the
add-issue-templates
branch
from
33522e5 to
5a833c5
Compare
venkywonka
force-pushed
the
add-issue-templates
branch
from
5a833c5 to
42194c8
Compare
venkywonka
force-pushed
the
add-issue-templates
branch
from
42194c8 to
1c1d172
Compare
|
/bot reuse --comment "No need to run full CI" |
GitHub Bot Help
Provide a user friendly way for developers to interact with a Jenkins server. Run See details below for each supported subcommand. Details
Launch build/test pipelines. All previously running jobs will be killed.
kill
Kill all running builds associated with pull request. skip
Skip testing for latest commit on pull request. reuse-pipeline
Reuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break. |
|
/bot skip --comment "No need to run full CI" |
|
@venkywonka It looks that some vulnerability scan failed with this PR. June |
|
PR_Github #14825 [ skip ] triggered by Bot |
|
PR_Github #14825 [ skip ] completed with state |
|
Thank you @juney-nvidia , that failure seemed to be one-off :D going forward with merging. |
Signed-off-by: Venky Ganesh <23023424+venkywonka@users.noreply.github.com>
Signed-off-by: Venky Ganesh <23023424+venkywonka@users.noreply.github.com>
Signed-off-by: Venky Ganesh <23023424+venkywonka@users.noreply.github.com>
Signed-off-by: Venky Ganesh <23023424+venkywonka@users.noreply.github.com>
venkywonka
force-pushed
the
add-issue-templates
branch
from
fb4e518 to
18b4e3e
Compare
|
/bot skip --comment "No need to run full CI" |
|
PR_Github #14831 [ skip ] triggered by Bot |
|
PR_Github #14831 [ skip ] completed with state |
…nd disable blank issues (NVIDIA#6494)" This reverts commit c9fe07e.
6 participants
Summary by CodeRabbit
New Features
Chores
Note to reviewers
*.ymlfiles have numbers in their names (i was too), GitHub orders your issue-form files purely by filename, so teams commonly prefix them with numbers to force a logical sequence.Test Coverage
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
Details
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id(OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.--disable-reuse-test(OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.--stage-list "A10-PyTorch-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.--test-backend "pytorch, cpp"(OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".--detailed-log(OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.--debug(OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in thestage-listparameter to access the appropriate container environment. Note: Does NOT update GitHub check status.For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.