Repository navigation
docs: Markdown の lint 指摘を解消する - #20
Merged
Merged
Conversation
中央テンプレ(tomio2480/github-workflows v2.22.2)の設定で, リポジトリ全体に markdownlint 58 件・textlint 226 件があった. 内容は変えず,表記と構造だけを直して 0 件にする. - 全角と半角の間,インラインコードとリンクの前後へ半角スペースを入れる (textlint --fix.オプションは中央設定と同じ) - 見出し・リスト・コードブロックの前後へ空行を入れる (markdownlint-cli2 --fix),言語のないコードブロックへ text を付ける - CONTRIBUTING.md の目次のリンク切れを直し,実在の見出しに合わせる - 「プルリクエスト」を表記辞書に従い「Pull Request」へ揃える - 長い文・読点の多い文・助詞の重複・冗長な表現を書き換える リポジトリの Markdown は句読点「、。」で統一されている.利用者向けの 手引きは「ですます調」である.中央設定が求める「である調」と句点 「.」は各ファイル先頭のコメントで無効化し,方針を CLAUDE.md に記す. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Lint summary
検査対象: 指摘はありません. Actions run: https://github.com/tomio2480/php-serial/actions/runs/39632046423/attempts/1 |
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
セルフレビュー実施済み.
/security-reviewは省略した(Markdown のみの差分で,実行コード・CI 設定・権限・依存関係を含まないため).概要
リポジトリの Markdown にたまっていた lint 指摘を解消する.
中央テンプレ(
tomio2480/github-workflowsv2.22.2)の設定で,markdownlint 58 件・textlint 226 件あった.内容は変えず,表記と構造だけを直して 0 件にする.
#19 の作り直しである.#19 は #18 のブランチを base にした stacked PR だった.
#18 のマージで base のブランチが削除され,GitHub が #19 を自動でクローズした.
そこで
mainから切ったブランチへ同じコミットを cherry-pick した.ツリーは #19 の head(b863558)と同一である.対応する Issue はない.#18 のレビューで,既存行の lint 指摘をスコープ外とした残りを扱う.
変更内容
表 1. 指摘の種類ごとの対応
textlint --fixで自動修正(オプションは中央設定と同じ)markdownlint-cli2 --fixで自動修正textを付けたCONTRIBUTING.mdの目次のリンク切れ文体と句読点の方針
リポジトリの既存の書き方に合わせる.方針は
CLAUDE.mdの「ドキュメントの文体」節に記した.README.md,docs/,CONTRIBUTING.md,examples/**/README.md)は「ですます調」で書く.CLAUDE.md,PHPDEV.md)は「である調」で書く.中央設定は「である調」と句点「.」を求める.上記と食い違うルールだけを,各ファイル先頭のコメントで無効化した.
文長・助詞の重複・表記ゆれなどの検査は有効なまま残る.
確認
bin/lint-md.sh --allで,markdownlint・textlint とも 0 件(終了コード 0).スコープ外
docs/WINDOWS_FFI_SETUP.mdは確認手順でexamples/test_ffi.phpを案内している.このファイルは.gitignoreの対象で,リポジトリに含まれていない.内容の修正にあたるため,本 PR では扱わない.🤖 Generated with Claude Code