PyCQA / PyCQA/flake8-bugbear

Policy on bugbears in usage of popular third party libraries

Open
#414 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted question
Dominant language
Python
Stars
1.1k
Forks
123
Avg merge
2d 5h
Merged PRs (30d)
5

Description

Hi, currently flake8-bugbear seems to primarily (only?) contain errors/warnings either inherent to python code or constructs from the python stdlib, but there are some popular third party libraries, such as MarkupSafe which also have very common usage mistakes, that are almost certainly bugs.

For MarkupSafe there is an existing flake8-plugin, however it hasn't been updated in three years and isn't published on pypi, so I'd feel a little bit better if it was part of a larger, actively maintained project.

So for now I'd just like to get a feel what the maintainers stance on this is, and if detecting such errors are welcome additions, I would be happy to submit a PR for this MarkupSafe specific issue to begin with. It would also be nice to have a contribution policy alongside the development instructions, so it's easier to gauge if it's worth opening a pull request for new errors/warnings or it'd be better suited as a standalone plugin.

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing the current development instructions and the linked flake8-markupsafe plugin. Determine whether third-party-library checks are welcome and whether a contribution policy should document the project’s scope. Done means the maintainers have an explicit policy or decision that can guide future pull requests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.