alan-turing-institute / alan-turing-institute/python-project-template

Linting rules are pretty strict

Open
#19 2 comments 1 reaction 0 assignees View on GitHub
enhancement question
Dominant language
Python
Stars
33
Forks
15
PR merge metrics
No merged PRs in 30d

Description

This might sometimes be what you want, but it's worth noting that
* the ruff rules are pretty strict and include automatically fixing a lot of issues. This is very much a matter of taste, but I personally dislike autofixes. For instance, I add an import, don't yet get to adding the part that uses the import, save the file, my editor automatically runs ruff and removes the import as unused.
* mypy complains a lot, including about missing stub packages and missing type annotations. I think we set it up with "loose" as the setting for typing (@rwood-97 is that right?).

These aren't necessarily issues to be fixed, but I wonder if it would be good to have options for some more relaxed linter/fixer rules when setting up.

Tagging @rwood-97 and @mastoffel since these were observations that came from working on a new repo with them.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.