search

bemanproject / beman

Organization, documentation, etc. for the Beman Project
https://bemanproject.org
Apache License 2.0
30 stars 11 forks source link

Adds linting via pre-commit #62

Open wusatosi opened 2 weeks ago

wusatosi commented 2 weeks ago

Propagates linting infrastructure.

Updated it to better fit beman:

  1. Adds codespell (auto fix not enabled)
  2. Update Markdown column limit to default (80) as this is more of a documentation library. Keeping Code block column size 120 to conform with norms in across projects so we can still copy-paste code over.

Updated all files so it passes linting.

steve-downey commented 1 week ago

We might later want to have a conversation about sentence or paragraphs on single line, so as to reduce diff noise, but it does require friendly editor configuration.

wusatosi commented 1 week ago

We might later want to have a conversation about sentence or paragraphs on single line, so as to reduce diff noise, but it does require friendly editor configuration.

Yeah let's have this setup before it's too late...

Actually, @steve-downey do you want me to create a .git-blame-ignore-revs for this?

steve-downey commented 1 week ago

Yes, as long as we're merging and not squashing, otherwise we just have to do it again.

wusatosi commented 1 week ago

Yes, as long as we're merging and not squashing, otherwise we just have to do it again.

Can you look over the formatted file? I think I will squash all the formatting commits and write that single commit hash into .git-blame-ignore-revs.

Just glance through this and see if I have made any dumb mistakes.