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

Future-proofing the example code

Abierto
#17 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
git
Área
documentation, tooling

Línea de trabajo

Comienza en el directorio preproc del repositorio y compara el preprocesador incluido con el preprocesador links predeterminado de mdBook. Investiga cómo los commits referenciados pueden seguir siendo alcanzables desde master y cómo se deben seleccionar las partes de los archivos que se incluirán. Se considera terminado cuando el tutorial puede extraer una porción de código en línea de un commit especificado sin depender de actualizaciones manuales repetidas.

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

Descripción

Parts II and III will have the reader (and thus, the writer as well) working iteratively on a codebase. Where it gets iffy is that any change made to earlier lessons must be consistently reflected in later lessons. (This could happen for example because an earlier lesson is amended to make "room for" a later one, to update the syntax for a newer RGBDS version etc.)

Propagating these changes throughout the tutorial, where they would be presented "inline", would be a massive pain. Instead, I suggest the codebase should be checked out into Git, and inline code examples pulled from that repo.

This does get somewhat involved in several ways (e.g. ensuring that all referenced commits are reachable from the master branch, keeping referenced line numbers consistent when rebasing, etc.), but I think is essential if we want to avoid the tutorial irremediably bit-rotting in the longer term.

The concrete solution, I'd say, is to build a mdBook preprocessor (either stand-alone, or as part of the bundled one), that is able to include portions of files (like the default links preproc is able to), but picking a version of that file in a specific commit. libgit integration is desirable so as to avoid a ton of slow git checkouts, but not necessary—the priority is to it make work.

Lenguaje dominante
Assembly
Estrellas
179
Forks
64
Merge medio
7 d 22 h
PR fusionados (30 d)
1

Guía de contribución

Abrir 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 gbdev/gb-asm-tutorial

Todos los issues de gbdev/gb-asm-tutorial

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.