github / github/markup

Include code files

オープン
#2,084 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Ruby
スター
6k
フォーク
3.4k
PR マージ指標
30日以内にマージされた PR はありません

説明

#1524

It would be great to have a way to include code files into README.rst. By separating the code to another file, we can do static type checking etc. on our examples to ensure they are always running correctly.

(I don't what the point of adding a stale bot is, if nobody triages the issues here...)

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Start by reading the referenced issue #1524 and the README.rst examples to determine the intended code-file inclusion behavior. Trace how README.rst is currently processed, then define and test a complete inclusion path whose behavior is clear for separated, statically checked examples.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
ruby
領域
documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。