Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Move vendored assets to Git Submodules and `.gitignore` built assets

Abierto
#2,052 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
git, github, nodejs, shell

Línea de trabajo

Empieza leyendo update-blog.sh, update-readmes.sh y update-lb4-docs.js; después, inspecciona cómo npm run build los invoca y cómo CI gestiona los assets generados. Define las ubicaciones de los submódulos y las rutas de build que deben ignorarse. Se considera terminado cuando las fuentes vendorizadas tienen una procedencia clara en Git, los builds dejan de sobrescribir copias generadas versionadas y el build existente del sitio sigue funcionando.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

ci developer-experience

The website has scripts which pulls data from GitHub and NPM:

  • update-blog.sh
    Clones loopbackio/loopback-blog into /blog
  • update-readmes.sh
    Downloads READMEs from GitHub "raw" or NPM Registry into /doc/en/[lb3|lb4|community]/readmes
  • update-lb4-docs.js
    Copies pre-generated markdown API Docs from @loopback/docs into /doc/en/lb4

They pose some issues:

  • Accidental manual editing: Contributors may accidentally contribute changes to these assets, only to be overridden by the CI pipeline.
  • Rate-limitng: Contributors running npm run build -> update-readmes.sh may inadvertently update the local copies with GitHub "rate limit reached" error pages.
  • Unclear provenance: As the .git directory is not preserved, the provenance of where and when exactly the assets were vendored is no clear.
  • Updates are reactive: The assets are only re-vendored when a PR is merged.

Git Submodules solve this problem. Updates would be handled by Renovate instead, which would open PRs.

Lenguaje dominante
HTML
Estrellas
276
Forks
382
Merge medio
6 h 54 min
PR fusionados (30 d)
22

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Sin plantilla de pull request
  • Leer la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de loopbackio/loopback.io

Todos los issues de loopbackio/loopback.io

Issues similares

Más issues de Build System

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.