Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bug report issue template #545

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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