japanese-text-style

日本語テキストスタイルガイド

日本語テキストを作成する際に適用する書式ルールを定義する。コミットメッセージ、PR タイトル/description、レビューコメントなど、すべての日本語テキストに適用する。

基本ルール

1. スペースのルール

日本語と半角英数字・記号の間には必ず半角スペースを挿入する。

正しい例:

Claude Code は、素晴らしい AI エージェントである。
React 18.2 をインストールした。
API エンドポイントを追加した。
TypeScript の型定義を修正した。

誤った例:

Claude Codeは、素晴らしいAIエージェントである。
React18.2をインストールした。
APIエンドポイントを追加した。
TypeScriptの型定義を修正した。

2. 句読点のルール

• 読点: 「、」を使用する (全角カンマ「，」は使用しない)
• 句点: 「。」を使用する (全角ピリオド「．」は使用しない)

正しい例:

機能を追加し、テストを実行した。
バグを修正したため、動作が改善された。

誤った例:

機能を追加し，テストを実行した．
機能を追加し, テストを実行した.

3. 括弧のルール

丸括弧は半角「()」を使用する。

正しい例:

Terraform は、IaC (Infrastructure as Code) のツールとして有名である。
詳細は README (英語版) を参照。
この機能は v2.0 (2024 年リリース予定) で追加される。

誤った例:

Terraform は、IaC（Infrastructure as Code）のツールとして有名である。
詳細は README（英語版）を参照。

適用対象

このスタイルガイドは以下のテキストに適用する:

対象	説明
コミットメッセージ	subject と body の両方
PR タイトル	Conventional Commits 形式の日本語部分
PR description	概要、変更内容、テスト方法など
レビューコメント	修正依頼や質問への返信

コミットメッセージの例

正しい例:

feat(auth): ログイン機能を追加

- メール/パスワード認証を実装
- セッション管理を追加
- JWT (JSON Web Token) を使用

誤った例:

feat(auth): ログイン機能を追加

- メール/パスワード認証を実装
- セッション管理を追加
- JWT（JSON Web Token）を使用

PR description の例

正しい例:

## 概要

ユーザー認証機能を追加。OAuth 2.0 を使用して、Google アカウントでのログインをサポート。

## 変更内容

- 認証モジュールを追加
- ログイン/ログアウト API を実装
- セッション管理 (Redis ベース) を追加

## テスト

- 単体テストを追加
- E2E テストで動作を確認

レビューコメントへの返信例

正しい例:

ご指摘ありがとうございます。修正しました。
確認していただけると助かります。

ご指摘の通り、エラーハンドリングが不足していました。
try-catch ブロックを追加し、適切にエラーを処理するようにしました。

チェックリスト

テキスト作成時に以下を確認する:

• 日本語と半角英数字・記号の間にスペースがあるか
• 句読点は「。」「、」を使用しているか
• 丸括弧は半角「()」を使用しているか