Future-proofing the example code
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 30/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- git
- 領域
- documentation, tooling
調査の方向性
リポジトリの preproc ディレクトリから始め、そこに同梱されているプリプロセッサと mdBook のデフォルトの links プリプロセッサを比較します。参照されているコミットを master から到達可能な状態に保つ方法と、含めるファイルの一部分をどのように選択すべきかを調査します。チュートリアルが、手動で繰り返し更新することなく、指定されたコミットからインラインコード部分を取得できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Assembly
- スター
- 179
- フォーク
- 64
- 平均マージ
- 7日 22時間
- マージ済み PR（30日）
- 1
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
gbdev/gb-asm-tutorial のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
gbdev/gb-asm-tutorial#194 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
gbdev/gb-asm-tutorial#184 · コメント 1 件 ·
-
good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
gbdev/gb-asm-tutorial#141 · コメント 2 件 · リアクション 2 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
gbdev/gb-asm-tutorial#109 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
gbdev/gb-asm-tutorial#183 ·
gbdev/gb-asm-tutorial の issue をすべて見る
似ている issue
-
content
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
GDQuest/learn-gdscript#1395 ·
-
rules
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
HttpClient
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
symfony/symfony-docs#23092 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
huggingface/sentence-transformers#4074 ·