PyCQA / PyCQA/bandit

Auto create a URL to file an issue when encountering an error

Open
#816 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
8.3k
Forks
835
Avg merge
5d 3h
Merged PRs (30d)
1

Description

Is your feature request related to a problem? Please describe.
When exceptions in Bandit occur as a result of bugs, the easier we make it to get bugs reported, the better.

Describe the solution you'd like
So when an exception is encountered in Bandit, instead of just logging the issue, provide a custom URL to the user
for them to open an issue on GitHub with much of the relevant information already populated.

See https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue

Describe alternatives you've considered
n/a

Additional context
n/a

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests. Start by tracing Bandit's exception-reporting entry point and review GitHub's issue-creation URL format; done means an exception presents a usable prefilled URL with relevant context and existing error logging remains covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.