🌰 donguri
一覧

調査ノート

気になったことを、根拠とともに読み返す。

15件のレポート

Markdownとは何か・何が便利なのか

開発

Markdownは、2004年にJohn Gruberが考案した「プレーンテキストのまま読み書きでき、後からHTMLに変換できる」軽量な記法。見出しや強調、リストなどを簡単な記号で書けるため、専門ツールがなくても構造化された文書を作れる点が便利で、GitHubなどのREADMEやドキュメント作成で広く使われている。ただし元の仕様には曖昧さがあり、実装ごとに解釈や拡張が異なる点には注意が必要だ。GitHubが使うGitHub Flavored Markdown(GFM)は、CommonMark仕様の厳密な上位互換として、表組みやタスクリストなどの拡張機能を加えたものである。

レポートを読む →

GitHub Issue と Discussion の違い、および donguriでの使い分け(改訂版)

開発

Issueは「対応すべき具体的な作業(タスク)」を追跡・管理する機能、Discussionは「結論を急がない自由な会話(質問・アイデア・告知など)」の場という設計思想の違いがある。donguriのように「アプリのアイデアをためる」「ちょっとした疑問をためる」用途であれば、Discussionsの Ideas / Q&A カテゴリに投稿し、実装すると決まったものだけをIssueに切り出す(Create issue from discussion機能で連携可能)運用が公式ドキュメントの設計意図に沿う。ただし、DiscussionはGitHub Projectsボードに直接追加できない制約があることが一次資料(github/roadmap#275が「Closed as not planned」でクローズ済み)で確定しており、この制約を理由に個人・小規模OSSではあえてIssueに一本化する運用も実務上支持されている。

レポートを読む →