レッスン 4
README と Issue テンプレート
明確な構造と再利用可能なセクションで README、CHANGELOG、Issue テンプレートを起草します。
Markdown は予測可能なドキュメント形状に従うとき最も価値があります。
README 構造
実用的なオープンソース README には次が含まれることが多いです。
# Project name
One-line summary.
## Features
- Feature A
- Feature B
## Quick start
```bash
npm install
npm run dev
Configuration
Explain env vars or config files.
License
MIT
読者は README を素早くスキャンします。プロジェクトの目的とクイックスタートを上部に置きます。
## CHANGELOG パターン
```markdown
## 1.2.0 - 2026-05-31
### Added
- CSV to JSON converter
### Fixed
- toolbar wrap on mobile
日付付きセクションとグループ化された変更タイプを使い、リリースノートをスキャンしやすく保ちます。
Issue テンプレート
Issue テンプレートは再現可能な情報を求めるべきです。
## Bug report
**Describe the bug**
**Steps to reproduce**
1.
2.
**Expected behavior**
**Environment**
- OS:
- Browser:
テンプレートは欠落した詳細を明らかにし、往復を減らします。
要点
強い README と Issue の Markdown は装飾ではなく構造的です。見出しでスキャンパスを作り、必要なセクションの近くに例を置きます。
公開前に Markdown Preview / Markdown to HTML ツールで README や Issue の例を読み込み、見出し階層を確認してください。