From 904345842644ee8b0c67e9267efbb85269190d85 Mon Sep 17 00:00:00 2001 From: Balaji Veeramani Date: Mon, 11 Apr 2022 22:45:32 -0700 Subject: [PATCH] Add bug report issue template --- .../workflows/ISSUE_TEMPLATE/bug-report.yml | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/workflows/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/workflows/ISSUE_TEMPLATE/bug-report.yml b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..37d6b6de --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,49 @@ +name: Bug report +description: Problems and issues with code of Ray +labels: [bug] + +body: + - type: markdown + attributes: + value: | + Thank you for reporting the problem! + Please make sure what you are reporting is a bug with reproducible steps. To ask questions + or share ideas, please post on our [Discussion page](https://discuss.ray.io/) instead. + + - type: textarea + attributes: + label: What happened + What you expected to happen + description: Describe 1. the bug 2. expected behavior 3. useful information (e.g., logs) + placeholder: > + Please provide the context in which the problem occurred and explain what happened. Further, + please also explain why you think the behaviour is erroneous. It is extremely helpful if you can + copy and paste the fragment of logs showing the exact error messages or wrong behaviour here. + + **NOTE**: please copy and paste texts instead of taking screenshots of them for easy future search. + validations: + required: true + + - type: textarea + attributes: + label: Versions / Dependencies + description: Please specify the versions of Ray, Python, OS, and other libraries that are used. + placeholder: > + Please specify the versions of dependencies. + validations: + required: true + + - type: textarea + attributes: + label: Reproduction script + description: > + Please provide a reproducible script. Providing a narrow reproduction (minimal / no external dependencies) will + help us triage and address issues in the timely manner! + placeholder: > + Please provide a short code snippet (less than 50 lines if possible) that can be copy-pasted to + reproduce the issue. The snippet should have **no external library dependencies** + (i.e., use fake or mock data / environments). + + **NOTE**: If the code snippet cannot be run by itself, the issue will be marked as "needs-repro-script" + until the repro instruction is updated. + validations: + required: true