search

Bouni / python-luxtronik

python-luxtronik is a library that allow you to interact with a Luxtronik heatpump controller.
MIT License
37 stars 20 forks source link

Add yamllint and markdownlint to pre-commit-hooks #120

Closed Bouni closed 1 year ago

Bouni commented 1 year ago

In order to get a consistent quality of our README.md (and probably other Markdown files to come) we should add markdownlint to our pre-commit-hooks.
Yamllint was added to ensure the .pre-commit-hooks.yaml is formated correctly as well.

kbabioch commented 1 year ago

Do we need to specify which files are to be scanned? At least for the GitHub action it is specified more explicitly:

Bouni commented 1 year ago

I've tested locally and without specifying a glob pattern it works perfectly fine for README.md and .pre-commit-hooks.yaml

kbabioch commented 1 year ago

My concern is more that there might be a difference in which files will be evaluated. Right now we're dealing with all files in the GitHub action. If we need to ignore a specific file / directory, I don't know how to do it with the pre-commit file, since there is no glob, etc.

But since we're scanning everything for now, let's worry about this, once we're facing this situation ;-).