Skip to content

Latest commit

 

History

History
138 lines (85 loc) · 6.29 KB

CONTRIBUTION.md

File metadata and controls

138 lines (85 loc) · 6.29 KB
Raw

開発ガイド

参加方法

  1. GitHub Issuesからアサインされていない issues 一覧からやりたい issue を選択します(希望のものがない場合はまず issue を作成してください)
  2. 選択した issue の Assignees にご自身を追加してください
  3. (もしまだしていなければ)このリポジトリをフォークします
  4. 変更をコミットします: コミットメッセージの先頭に翻訳したページのタイトルを[XXXX]のような形で入れてもらえると助かります
  5. lint で引っかかる場合は再度修正を行いコミットします
  6. ページ冒頭の最終更新日を更新しているか確認をお願いします
  7. フォークした自分のリポジトリに Push します: git push origin my-branch
  8. 問題がなければプルリクエストを送ります
  9. レビューで指摘事項があったら修正し、再度 Push します
  10. レビュー 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.

  • 訳文:

    もっと簡単な方法で文字列の中に値を含めることができます。値を括弧で囲み、括弧の前にバックスラッシュをつけます。

文中に現れる強調に関して

原文の HTML には、強調する目的で文中に <span> や <code> が使われている箇所があります。そこで取り上げているテーマの注目すべき単語、識別子、数字などに使われるものですが、翻訳時の Markdown ではバックティック (`backtick`) で強調するようお願いします。

  • 例:
    • <span>Swift</span> -> `Swift`
    • <span>0b01010011</span> -> `0b01010011`
    • <code>func</code> -> `func`

単語の統一 (特に技術用語)

  • 技術用語は基本英語、ただ日本語で一般的に使われている場合は日本語 OK
    • 例: 英語の filter、日本語のフィルタ
  • 和訳に困った、とりあえず英語
    • 例: expression -> 式、表現
  • 和訳にして分かりづらい場合は、翻訳と英語(どちらかに括弧付け)でも OK
    • 例: Two way -> Two way (双方向)

長音訳について

原則、長音なしで翻訳する。

  • ❌ コンピューター
  • ⭕️ コンピュータ

ただし、長音なしで訳した場合、意味が分かりにくいものは、例外として長音ありで訳してもよいです。

Pull Request flow

  • ❌ プルリクエストフロ
  • ⭕️ プルリクエストフロー

翻訳チェック

textlintに

を適用してチェックしています。

※ 一部チェック項目を除外しています。内容は.textlintrcを参照ください。

手動で lint を行う場合は下記を実行してください。

npm run lint

フィードバック

ご要望、ご質問などございましたら Discord チャンネルよりお願いします。