Skip to content

Pre-commit hooks need more documentation #289

Open
@garloff

Description

@garloff

As mentioned in #287 (comment) (point 4), commits are not working without further work.
(a) https://docs.scs.community/community/contribute/linting-guide/ says that husky, prettier and markdownlint-cli2 are being used. Following the links and following the install instructions means installing npm install --save-dev husky (which is harmless), npm install --save-dev --save-exact prettier (which pulls in a few dozen dependencies and may not be as harmless) and npm install --save-dev markdownlint-cli2 (not exatcly harmless either) . Explicitly mentioning that those two npm packages need to be installed (maybe best into a container) would be good.
(b) It still does not work as is, as the docs repo has this

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

in .husky/pre-commit
This file does not exist in git. I created an empty one to make commits work, but this is likely not how it's supposed to be done ...

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions