Pre-commit hooks need more documentation

Open
#289 2 comments 0 reactions 1 assignee View on GitHub

@maxwolfs is already working on this.

Since Jan 23, 2025.

Assessment

This issue has not been assessed yet.

Description

documentation

As mentioned in https://github.com/SovereignCloudStack/docs/issues/287#issuecomment-2606535752 (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 ...

Dominant language
JavaScript
Stars
18
Forks
10
Avg merge
15h 16m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SovereignCloudStack/docs

All issues in SovereignCloudStack/docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.