Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(closes #30) add basic formatting and linting pipeline #37

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

qdbp
Copy link
Contributor

@qdbp qdbp commented Oct 7, 2024

(closes #30)

this is my first naive stab at a code quality gate

I think this is quite a high priority since we're already at files with mixed indentations. barring this we're going to have a tough time keeping diff surface area low, which will make reviews painful.

any specifics (i.e. line length) obviously open for discussions

@aw632
Copy link

aw632 commented Oct 7, 2024

nit: add "closes #30" in your PR description so it gets linked

@qdbp qdbp changed the title (fixes #30) add basic formatting and linting pipeline (closes #30) add basic formatting and linting pipeline Oct 7, 2024
@qdbp qdbp force-pushed the gh30-implement-basic-code-quality-gate branch from 7ad7a8b to c7eb4ab Compare October 7, 2024 20:29
@aw632
Copy link

aw632 commented Oct 7, 2024

Thoughts on using an opinionated code formatter like black instead? that would sidestep all the discussions about line length and such.

@qdbp
Copy link
Contributor Author

qdbp commented Oct 7, 2024

my underestanding is that ruff format is supposed to be as opinionated as black, with some slightly better defaults: https://github.com/astral-sh/ruff/blob/main/docs/formatter/black.md. Funnily enough, I think line length is the single configuration option that black has.

I was surprised to see that it supports custom indents (maybe they changed that), tbh my preference is to just use an indent of 4 -- but I don't want to just steamroll everyone on a whim either. I expect the BDFL will dictate

@qdbp qdbp force-pushed the gh30-implement-basic-code-quality-gate branch from c7eb4ab to 093736f Compare October 7, 2024 21:34
@qdbp qdbp force-pushed the gh30-implement-basic-code-quality-gate branch from 093736f to 0b997a2 Compare October 7, 2024 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC] boring stuff: add linter + formatter
2 participants