| name | markdown-conventions |
| description | Markdown記法の規約を適用する。PR本文、Issue本文、ドキュメント、README作成時に使用する。チェックボックス、箇条書き、コードブロック、リンクの書式ルールを含む。 |
Markdown記法の規約
Issue本文やPR本文、ドキュメント作成時は以下のルールを厳守する。
チェックボックス
- 必ず
- [ ] または - [x] 形式を使用(ハイフン + スペース + 角括弧)
[ ] のみ(ハイフンなし)は使用禁止
- インデントは2スペース単位で統一
箇条書き
- 箇条書きは必ず
-(ハイフン)を使用
•(ビュレット)や *(アスタリスク)は使用禁止
- ネストは2スペースでインデント
- リスト項目の前後は空行を入れない(同一リスト内)
構造
- セクション間は必ず空行を1行入れる
- チェックボックスリストは独立したセクションとして扱う
- タスクリストは「## タスク」セクションにまとめる
コードブロック
- インラインコードは
` で囲む
- コードブロックは言語指定を必ず行う(例:
```bash)
- ファイルパスは必ずインラインコードで囲む
リンク
- Issue番号は
#4264 形式で記述
- URLは
[テキスト](URL) 形式を使用
例
正しい形式:
## タスク
- [ ] タスク1
- サブタスク1
- サブタスク2
- [ ] タスク2
- `local/scripts/hoge-new/` ディレクトリにスクリプトを作成
- 前回の `hoge-old/` スクリプトをベースに改良
間違った形式:
## タスク
[ ] タスク1 ← ハイフンがない
• サブタスク1 ← ビュレットは使用禁止
- サブタスク2 ← インデントが不統一