Pre-commit hooks need more documentation
@maxwolfs ya está trabajando en esto.
Desde el 23/1/2025.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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 ...
- Lenguaje dominante
- JavaScript
- Estrellas
- 18
- Forks
- 10
- Merge medio
- 15 h 22 min
- PR fusionados (30 d)
- 1
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de SovereignCloudStack/docs
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
SovereignCloudStack/docs#387 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
SovereignCloudStack/docs#329 ·
-
documentation enhancement
SovereignCloudStack/docs#308 · 10 comentarios · 2 asignados ·
-
Move "Add documentation on OVN BGP agent setup with EVPN" to documentationQuizá libre de nuevo @scoopex la tomó hace 676 días y no hay ningún pull request abierto. Abierto
SovereignCloudStack/docs#276 · 1 asignado ·
-
Add "Add Kolla Ansible encryption state document to SDN #62" to documentation.Quizá libre de nuevo @scoopex la tomó hace 676 días y no hay ningún pull request abierto. Abierto
SovereignCloudStack/docs#275 · 1 asignado ·
Todos los issues de SovereignCloudStack/docs
Issues similares
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
PedestrianDynamics/pyFDS-Evac#476 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
aiko-chan-ai/DiscordBotClient#380 ·
-
Offisielle trærAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Daemon delete dialog: "Remove all ExApps" checkbox and `removeExApps` parameter have no effectAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Los mantenedores suelen responder en 3 días
-
Add: Atlas TVAbiertochannels:add check:passed
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 4 días