Skip to content

Add a new bug report template #136

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.

Sign up for GitHub

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

Merged
wstcliyu merged 2 commits into from
Dec 15, 2025
Merged

Add a new bug report template #136

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97187d1
Add a new bug report template
wstcliyu Dec 10, 2025
85243c4
Merge branch 'main' into wstcliyu/bug-report-template
wstcliyu Dec 15, 2025
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
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ["bug", "triage"]
assignees: ''
Copy link
Collaborator

@lukebaumann lukebaumann Dec 10, 2025

Choose a reason for hiding this comment

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

I am not sure what this table is meant for

Copy link
Collaborator Author

@wstcliyu wstcliyu Dec 15, 2025

Choose a reason for hiding this comment

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

The title can be something like "[Bug]: "
The labels can be something like ["bug", "triage"]
The assignees are a list of assignees to whom the bug would be assigned.


---

**Type of the bug**
Identify whether it is a pathway-utils bug, or a general Pathways bug or an ML bug.

**Initial troubleshooting steps**
- Check the user workload log and confirm the error is not due to the workload itself.
- Check whether this is a bug with Pathways or the same error also happens to running with multi-controller JAX.

**Pathways image SHAs or tags**
The SHAs or tags of the Pathways server image and the Pathways proxy server image used.

**Describe the bug**
A clear and concise description of what the bug is.

**Expected behavior**
A clear and concise description of what you expected to happen.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Run command '....'
3. See error

**Logs**
The output of `kubectl describe jobset <jobset_name>`. Logs from the workload, pathways-proxy, pathways-rm, and all of the pathways-workers would be helpful. Please share the logs in a tarball or in a GCS bucket.

**Additional context**
Add any other context about the problem here.