- GitHub Issuesからアサインされていない issues 一覧からやりたい issue を選択します(希望のものがない場合はまず issue を作成してください)
- 選択した issue の Assignees にご自身を追加してください
- (もしまだしていなければ)このリポジトリをフォークします
- 変更をコミットします: コミットメッセージの先頭に翻訳したページのタイトルを[XXXX]のような形で入れてもらえると助かります
- lint で引っかかる場合は再度修正を行いコミットします
- ページ冒頭の最終更新日を更新しているか確認をお願いします
- フォークした自分のリポジトリに Push します:
git push origin my-branch - 問題がなければプルリクエストを送ります
- レビューで指摘事項があったら修正し、再度 Push します
- レビュー OK ならば、マージされて内容がドキュメントに反映されます
※ PR を作成しなくても、間違いを見つけたり、もっとこうした方が良いなどのご意見がございましたら issue を立てて教えていただけるだけでも大変うれしいです🙏🏻
まず始めに実行してください。
npm install
※あくまで目安です。ある程度はその場の自己裁量で行なっています。
「だである」 ではなく 「ですます」 調
Swift is a fantastic way to write software.
❌ Swift はソフトウェアを書くための素晴らしい手段 である。
⭕️ Swift はソフトウェアを書くための素晴らしい手段 です。
Swift has struct and class.
❌ Swiftには、structとclassがあります。
⭕️ Swift には、struct と class があります。
例外として、句読点の前後に半角文字がある場合は、スペースを入れなくても大丈夫です。
読点: Swift には**、struct** と class、 があります。
※ commit 時にチェックしていますが、一部コード内のコメントや引用コメントでは有効ではありません。(方法を探し中)
The compiler is optimized for performance and the language is optimized for development, without compromising on either.
❌ コンパイラはパフォーマンスが最適化され、言語は開発に最適化されています。どちらも妥協することなく。
⭕️ コンパイラによるパフォーマンスの最適化、言語による開発のしやすさの最適化、どちらも実現できるようにしています。
※ 直訳だと意味がわかりにくい箇所が結構あると思うので、意味が変わらない限りは、読みやすさを優先したいと思います。
Example:
❌ 例
⭕️ 例:
ただし、文の途中にハイフン - やセミコロン ; がある場合は、その記号があると理解しづらい訳になる場合は、例外として削除してもよいです。
-
原文:
There’s an even simpler way to include values in strings: Write the value in parentheses, and write a backslash () before the parentheses.
-
訳文:
もっと簡単な方法で文字列の中に値を含めることができます。値を括弧で囲み、括弧の前にバックスラッシュをつけます。
- 技術用語は基本英語、ただ日本語で一般的に使われている場合は日本語 OK
- 例: 英語の filter、日本語のフィルタ
- 和訳に困った、とりあえず英語
- 例: expression -> 式、表現
- 和訳にして分かりづらい場合は、翻訳と英語(どちらかに括弧付け)でも OK
- 例: Two way -> Two way (双方向)
原則、長音なしで翻訳する。
- ❌ コンピューター
- ⭕️ コンピュータ
ただし、長音なしで訳した場合、意味が分かりにくいものは、例外として長音ありで訳してもよいです。
Pull Request flow
- ❌ プルリクエストフロ
- ⭕️ プルリクエストフロー
- textlint-rule-preset-JTF-style
- textlint-rule-period-in-list-item
- textlint-rule-no-mix-dearu-desumasu
- textlint-rule-detect-bad-chars
- textlint-rule-preset-ja-spacing
- textlint-rule-proofdict
を適用してチェックしています。
※ 一部チェック項目を除外しています。内容は.textlintrcを参照ください。
手動で lint を行う場合は下記を実行してください。
npm run lint