Typing and formatting
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.2k
- Forks
- 754
- PR merge metrics
- No merged PRs in 30d
Description
I would like to volunteer to add type hints with mypy checks and include a formatting tool like Black or Ruff on the main file and tests. But before I have to ask:
-
Is introducing a formatting tool an acceptable change? There are some places where I would like to change the styling a bit.
-
If running a formatting tool on the code is not an option, but type hints are, should they be added inline or in a separate
.pyifile?
I'm not looking to be disruptive. I just want to know if this is a nice-to-have or if it's not needed
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the main Python file and the tests mentioned in the issue, then determine whether maintainers want mypy checks, a formatter, or both. The work is not ready to begin until the formatter choice, typing location, and concrete scope are decided; done would mean implementing that agreed scope consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100