diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 452117b53d..211a30923c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,7 +11,7 @@ assignees: '' A clear and concise description of what the bug is. **Steps/Code to reproduce bug** -Follow this guide http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports to craft a minimal bug report. This helps us reproduce the issue you're having and resolve the issue more quickly. +Follow the [RAPIDS issue guidelines](https://docs.rapids.ai/contributing/issues/) (search existing issues first, then describe the problem so it can be understood and reproduced). Use the cuOpt issue template that best fits; the RAPIDS page describes general practices. Provide clear steps (and code or data) so we can reproduce the issue and resolve it more quickly. **Expected behavior** A clear and concise description of what you expected to happen. diff --git a/.github/ISSUE_TEMPLATE/numerical_instability.md b/.github/ISSUE_TEMPLATE/numerical_instability.md new file mode 100644 index 0000000000..3a75b0c480 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/numerical_instability.md @@ -0,0 +1,25 @@ +--- +name: "Numerical issues" +about: "Report numerical issues (e.g., NaNs/Infs, ill-conditioning, tolerance or scaling issues)" +title: "[NUMERICAL_ISSUES]" +labels: "? - Needs Triage, numerical issues" +assignees: '' + +--- + +**Describe the numerical issue** +A clear description of the numerical problem (e.g., NaN/Inf values, unexpected divergence, extreme sensitivity to small input changes). + +**Steps / minimal reproduction** +Follow the [RAPIDS issue guidelines](https://docs.rapids.ai/contributing/issues/) (search existing issues first, then describe the problem so it can be understood and reproduced). Use the cuOpt issue template that best fits; the RAPIDS page describes general practices. Include inputs, API calls, and solver settings (tolerances, scaling, precision) that reproduce the behavior. + +**Expected vs actual behavior** +What you expected numerically, and what you observed (including any error messages or logs). + +**Environment details (please complete the following information):** + - Environment location: [Bare-metal, Docker, Cloud (specify cloud provider)] + - Method of cuOpt install: [conda, Docker, or from source] + - If method of install is [Docker], provide `docker pull` & `docker run` commands used + +**Additional context** +Add any other context (hardware, CUDA/driver versions, data scaling, problem size) that may help diagnose the issue.