From 24e99c5d80674f4145c0b21027eb9fe579e36bb6 Mon Sep 17 00:00:00 2001 From: Jirka B Date: Wed, 21 Aug 2024 10:20:31 -0400 Subject: [PATCH] docs: update bug template --- .github/ISSUE_TEMPLATE/bug_report.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 150f7849963..928a3b2dfaf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -19,8 +19,10 @@ Steps to reproduce the behavior...
Code sample - +```python +# Ideally attach a minimal code sample to reproduce the decried issue. +# Minimal means having the shortest code but still preserving the bug. +```
@@ -30,9 +32,9 @@ Minimal means having the shortest code but still preserving the bug. --> ### Environment -- TorchMetrics version (and how you installed TM, e.g. `conda`, `pip`, build from source): -- Python & PyTorch Version (e.g., 1.0): -- Any other relevant information such as OS (e.g., Linux): +- TorchMetrics version (if build from source, add commit SHA): ??? +- Python & PyTorch Version (e.g., 1.0): ??? +- Any other relevant information such as OS (e.g., Linux): ??? ### Additional context