Skip to content

feat: add automated bug triage utility (#14561)#14611

Open
Yeeyash wants to merge 6 commits intoTheAlgorithms:masterfrom
Yeeyash:main
Open

feat: add automated bug triage utility (#14561)#14611
Yeeyash wants to merge 6 commits intoTheAlgorithms:masterfrom
Yeeyash:main

Conversation

@Yeeyash
Copy link
Copy Markdown

@Yeeyash Yeeyash commented May 2, 2026

Describe your change:

This PR adds a utility script bug_triage.py that automates the classification of bug reports based on severity keywords (e.g., "crash", "slow"). It provides a structured Markdown summary of open bugs categorized by priority.

Changes:

  • Implemented keyword-based severity detection (S1-S4).
  • Added automatic directory creation using pathlib for robustness.
  • Included type hints and docstrings for all functions.
  • Added doctests to ensure mapping logic is accurate.

Wikipedia URL: https://en.wikipedia.org/wiki/Triage

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper Bot added awaiting reviews This PR is ready to be reviewed require tests Tests [doctest/unittest/pytest] are required labels May 2, 2026
Copy link
Copy Markdown

@algorithms-keeper algorithms-keeper Bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

Comment thread bug_triage.py
"S2": "P2",
"S3": "P3"
}
return priority_map.get(severity, "P4")
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file bug_triage.py, please provide doctest for the function read_bugs

Comment thread bug_triage.py

return bugs


Copy link
Copy Markdown

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file bug_triage.py, please provide doctest for the function generate_report

@algorithms-keeper algorithms-keeper Bot added the tests are failing Do not merge until tests pass label May 2, 2026
@algorithms-keeper algorithms-keeper Bot removed the require tests Tests [doctest/unittest/pytest] are required label May 2, 2026
@Yeeyash Yeeyash force-pushed the main branch 3 times, most recently from c356ce0 to d1ffd53 Compare May 2, 2026 15:54
@algorithms-keeper algorithms-keeper Bot removed the tests are failing Do not merge until tests pass label May 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviews This PR is ready to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants