traPtitech / traPtitech/Checkin

会員・会計機能で追加された TypeScript / Vue ファイルのコメントを日本語に統一する

Open
#54 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
3d 5h
Merged PRs (30d)
7

Description

現状

このリポジトリは、コードのコメント・ドキュメント・UI の表示文言・エラーメッセージを日本語に統一する方針を採っている(#12 で既存のコメントを日本語化した。識別子は対象外)。

会員・会計機能の追加で入った .ts / .vue のファイルは、その大半が英語のコメントを持っている。2026-09-18 に feat/merge-auth-collectiond8feaca で次のコマンドを実行したところ、79 ファイルが該当した。

git diff --name-status origin/main...HEAD \
  | awk '$1=="A"{print $2}' \
  | grep -E '\.(ts|vue)$' \
  | while read f; do
      grep -hE '^[[:space:]]*(//|\*|/\*)' "$f" \
        | grep -v '[^ -~	]' \
        | grep -qE '[A-Za-z]{3,}' && echo "$f"
    done \
  | wc -l

このコマンドは、追加された .ts / .vue のうち「非 ASCII 文字を含まず、3 文字以上の英字の並びを含むコメント行」を 1 行以上持つファイルを数える。行数の多いものは packages/api/src/payouts/execute.tspackages/api/src/jomon/http.tspackages/api/src/stripe/connect.tspackages/api/src/auth/identity.ts である。

対象はコードのコメントに限る。UI の利用者に見える文字列は追加時から日本語なので対象外である。

誰が何を誤るか

コメントを書き足す人が、同じファイルの中で英語と日本語のどちらに合わせればよいか判断できない。ファイルごとに言語が違う状態が続くと、方針が撤回されたのか未着手なのかも読み取れない。

直さずに残した理由

対象が広く、コメントの書き換えは意味の取り違えを起こしうるので、機能の変更と同じ単位で行うと差分の確認が難しくなる。翻訳だけを独立した変更として行うほうが確認しやすい。

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run the issue's shell command from the repository root to identify the added .ts and .vue files, then review the comments in the listed high-volume files: packages/api/src/payouts/execute.ts, packages/api/src/jomon/http.ts, packages/api/src/stripe/connect.ts, and packages/api/src/auth/identity.ts. Translate code comments to Japanese without changing identifiers or user-visible strings; done means the targeted comments follow the repository's Japanese-language policy.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.