apache / apache/cloudstack

Add `markdown-link-check` with `pre-commit` to check for dead links in Markdown files

オープン
#11,290 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る
type:enhancement
主要言語
Java
スター
3.1k
フォーク
1.4k
平均マージ
6日 19時間
マージ済み PR(30日)
32

説明

https://github.com/tcort/markdown-link-check

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#run-as-a-pre-commit-hook

```
- repo: https://github.com/tcort/markdown-link-check
rev: ...
hooks:
- id: markdown-link-check
args: [-q]
```

We will need a config file with various rules:

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#config-file-format

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

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

調査の方向性

issue でリンクされている markdown-link-check の README セクション、特に “Run as a pre-commit hook” と “Config file format” から始めます。リポジトリの pre-commit 設定の場所を特定し、hook と必要なルールを追加してから、設定済みの pre-commit チェックを Markdown ファイルに対して実行し、リンク切れが意図したとおりに報告されることを確認します。

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

評価

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

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

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