Skip to content

Add GitHub issue template for numerical instability reports#982

Open
anandhkb wants to merge 3 commits intoNVIDIA:release/26.04from
anandhkb:release/26.04
Open

Add GitHub issue template for numerical instability reports#982
anandhkb wants to merge 3 commits intoNVIDIA:release/26.04from
anandhkb:release/26.04

Conversation

@anandhkb
Copy link
Contributor

Currently, only have a BROAD category called BUG which intuitively connotes a functional issue such as a crash, inconsistency etc.

Adding a new category called numerical instability to track numerical issues.

@anandhkb anandhkb added this to the 26.04 milestone Mar 22, 2026
@anandhkb anandhkb requested a review from a team as a code owner March 22, 2026 01:32
@anandhkb anandhkb requested a review from rgsl888prabhu March 22, 2026 01:32
@copy-pr-bot
Copy link

copy-pr-bot bot commented Mar 22, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@anandhkb anandhkb added non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels Mar 22, 2026
@anandhkb anandhkb requested a review from Iroy30 March 22, 2026 01:32
@coderabbitai
Copy link

coderabbitai bot commented Mar 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 280e58aa-a1d1-4d84-9850-9dd09749bdf9

📥 Commits

Reviewing files that changed from the base of the PR and between 26f76ba and 496a2a9.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/numerical_instability.md
✅ Files skipped from review due to trivial changes (1)
  • .github/ISSUE_TEMPLATE/numerical_instability.md

📝 Walkthrough

Walkthrough

Added a new GitHub issue template for numerical instability reports and updated the bug report template to reference RAPIDS issue guidelines, advise searching existing issues, and encourage choosing the appropriate cuOpt issue template.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/numerical_instability.md, .github/ISSUE_TEMPLATE/bug_report.md
Added numerical_instability.md: new issue template with metadata (custom name/title/labels) and structured prompts covering numerical issue description (NaN/Inf, ill-conditioning, sensitivity), minimal reproduction steps with cuOpt-specific details (inputs, API calls, solver settings such as tolerances/scaling/precision), expected vs actual behavior, environment details including location and cuOpt install method and Docker docker pull/docker run commands, and additional diagnostics (hardware, CUDA/driver, problem size). Updated bug_report.md: revised "Steps/Code to reproduce" guidance to reference RAPIDS issue guidelines, recommend searching existing issues, and selecting the most appropriate cuOpt issue template while providing clear reproduction steps and code/data.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a GitHub issue template for numerical instability reports, which matches the primary modification in the changeset.
Description check ✅ Passed The description is directly related to the changeset, explaining the motivation for the new issue template by distinguishing numerical issues from functional bugs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/ISSUE_TEMPLATE/numerical_instability.md:
- Line 14: Update the Markdown line containing the minimal bug report guide so
the URL uses HTTPS instead of HTTP; locate the string "Follow this guide
http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports" and replace
the URL with
"https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports" to ensure
the link is secure.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1526104c-b2b9-461d-8a9e-3dd47cad7a57

📥 Commits

Reviewing files that changed from the base of the PR and between d7aa673 and 2c8cb90.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/numerical_instability.md

@anandhkb anandhkb requested a review from chris-maes March 22, 2026 04:56
Rename numerical instability to numerical issue
@anandhkb
Copy link
Contributor Author

@chris-maes and @Iroy30 for re-review, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant