Skip to content

docs: Markdown の lint 指摘を解消する - #19

Closed
tomio2480 wants to merge 1 commit into
fix/harden-runtime-safetyfrom
docs/fix-lint-debt
Closed

tomio2480 wants to merge 1 commit into
fix/harden-runtime-safetyfrom
docs/fix-lint-debt

Conversation

@tomio2480

Copy link
Copy Markdown
Owner

セルフレビュー実施済み./security-review は省略した(Markdown のみの差分で,実行コード・CI 設定・権限・依存関係を含まないため).

概要

リポジトリの Markdown にたまっていた lint 指摘を解消する.
中央テンプレ(tomio2480/github-workflows v2.22.2)の設定で,markdownlint 58 件・textlint 226 件あった.
内容は変えず,表記と構造だけを直して 0 件にする.

本 PR は #18 のブランチを base にした stacked PR である.
main から切ると,README の同じ箇所を #18 と本 PR の両方が触って衝突するためである.
#18 のマージ後に base を main へ付け替える.

対応する Issue はない.#18 のレビューで,既存行の lint 指摘をスコープ外とした残りを扱う.

変更内容

表 1. 指摘の種類ごとの対応

指摘 件数 対応
全角と半角の間・コードやリンクの前後のスペース 160 textlint --fix で自動修正(オプションは中央設定と同じ)
見出し・リスト・コードブロックの前後の空行 51 markdownlint-cli2 --fix で自動修正
コードブロックの言語指定がない 5 text を付けた
句点「.」・である調の要求 53 ファイル先頭のコメントで無効化(方針は後述)
表記ゆれ「プルリクエスト」 4 辞書に従い「Pull Request」へ揃えた
CONTRIBUTING.md の目次のリンク切れ 1 目次を実在の H2 見出しに合わせた
長い文・読点の多い文・助詞の重複・冗長な表現など 10 文を書き換えた

文体と句読点の方針

リポジトリの既存の書き方に合わせる.方針は CLAUDE.md の「ドキュメントの文体」節に記した.

  • Markdown の句読点は「、。」で統一する.
  • 利用者・開発者向けの手引き(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

中央テンプレ(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>
@github-actions

Copy link
Copy Markdown

Lint summary

ツール この PR の差分 リポジトリ全体
markdownlint 0 0
textlint 0 0

検査対象: Merge b863558 into 2e83ad9(base: 2e83ad9)

指摘はありません.

Actions run: https://github.com/tomio2480/php-serial/actions/runs/39631355859/attempts/1

@tomio2480
tomio2480 deleted the branch fix/harden-runtime-safety October 21, 2026 16:07
@tomio2480 tomio2480 closed this Oct 21, 2026
@tomio2480

Copy link
Copy Markdown
Owner Author

#18 のマージで base ブランチが削除され,本 PR は自動でクローズされた.同じコミットを main から切ったブランチへ cherry-pick し,#20 として作り直した.

@coderabbitai

coderabbitai Bot commented Oct 21, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: aa4eee6c-605a-4331-b669-c483b451fe3a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@tomio2480
tomio2480 deleted the docs/fix-lint-debt branch October 21, 2026 16:20
tomio2480 added a commit that referenced this pull request Oct 22, 2026
#18 で下した判断(STDERR のフォールバック,read() の丸め,Web SAPI の
再現方法)と,棄却した代替案を記録する.FFI の CData 比較・所有権の
想定外の挙動と,stacked PR の #19 が自動クローズされた経緯も残す.

あわせて CLAUDE.md の文体方針に,docs/notes/ は判断の記録として
「である調」で書くことを加える.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant