docs: translate style-guide

.github/workflows/lint.yml

@@ -5,9 +5,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Setup reviewdog
+        run: |
+          mkdir -p $HOME/bin && curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b $HOME/bin
+          echo ::add-path::$HOME/bin
+          echo ::add-path::$(go env GOPATH)/bin # for Go projects
+      - name: Install dependencies
+        run: yarn install
       - name: textlint
-        uses: tsuyoshicho/action-textlint@v1
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          reporter: github-pr-review
-          textlint_flags: "docs/**/*.md"
+        run: $(yarn bin)/textlint -f checkstyle ${FILES} | reviewdog -f=checkstyle -name="textlint" -reporter=github-pr-check -level=${LEVEL}
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FILES: README.md docs/**/*.md
+          LEVEL: error

.textlintrc.js

@@ -10,20 +10,18 @@ module.exports = {
       "1.1.3.箇条書き": false, // 箇条書きの文末に句点(。)以外を許可
       "3.1.1.全角文字と半角文字の間": false, // 全角文字と半角文字の間にスペースを入れる
       "4.2.7.コロン(：)": false, // 半角コロンを許可
+      "2.1.5.カタカナ": true,
+      "2.1.6.カタカナの長音": true, // カタカナ語の長音は基本的に伸ばす
+      "2.2.1.ひらがなと漢字の使い分け": true,
     },
     // https://github.com/textlint-rule/textlint-rule-prh
     prh: { rulePaths: ["./prh.yml"] },
     "ja-technical-writing/no-exclamation-question-mark": false, // 文末の感嘆符を許可
-    "ja-technical-writing/max-ten": {
-      // 句点の数を緩和
-      max: 5,
-    },
+    "ja-technical-writing/max-ten": { max: 5 }, // 句点の数を緩和
     "ja-technical-writing/ja-no-weak-phrase": false, // 弱い表現の許容
+    "ja-technical-writing/ja-no-mixed-period": { allowPeriodMarks: ["："] }, // 文末は。、：で終わる
     "ja-technical-writing/sentence-length": false, // 翻訳完了後に有効化
     "ja-technical-writing/max-comma": false, // 翻訳完了後に有効化
-    "ja-technical-writing/ja-no-mixed-period": {
-      allowPeriodMarks: ["："],
-    },
     "textlint-rule-ja-hiragana-hojodoushi": true, // ひらがなにしたほうが良い補助動詞
     "textlint-rule-ja-hiragana-fukushi": true, // ひらがなにしたほうが良い副詞
   },

README.md

@@ -1,10 +1,10 @@
 # Gatsby Japanese Translation
 
-このリポジトリでは Gatsby 公式ドキュメントの日本語版を作成しています。
+このリポジトリーでは Gatsby 公式ドキュメントの日本語版を作成しています。
 
 翻訳の進捗は [Translation Progress Issue](https://github.com/gatsbyjs/gatsby-ja/issues/1) を確認してください。
 
-日本語訳や日本語版特有の問題を見つけた場合はこのリポジトリの Issue / Pull Request を使って報告ないし改善を提案してください。
+日本語訳や日本語版特有の問題を見つけた場合はこのリポジトリーの Issue / Pull Request を使って報告ないし改善を提案してください。
 
 ## 翻訳・修正等に興味がある方へ
 
@@ -15,7 +15,7 @@
 - このページの右上にある Fork ボタンからこのレポジトリを Fork してください。
 - Git, Node.js, Yarn をそれぞれ準備して、 Fork したリポジトリをクローンしてください。
 - `yarn` を使って dependency のインストールを行ってください。
-- これで準備は完了です！ `docs` の中身の markdown を好みのテキストエディタで編集してください。
+- これで準備は完了です！ `docs` の中身の markdown を好みのテキストエディターで編集してください。
 
 ### 作業の重複を防ぐための宣言
 

docs/contributing/code-of-conduct.md

@@ -4,7 +4,7 @@ title: Gatsby コントリビューター行動規範
 
 ## 私たちの約束
 
-私たちはオープンかつ友好的なコミュニティを育成するために、コントリビューターやメンテナーとして、年齢、体型、障碍、民族性、性自認および性別表現、経験レベル、国籍、個人の容姿、人種、信仰、性的同一性および指向に関わりなく、私たちのプロジェクトやコミュニティへの参加を誰にとっても嫌がらせのない体験にすることを誓います。
+私たちはオープンかつ友好的なコミュニティーを育成するために、コントリビューターやメンテナーとして、年齢、体型、障がい、民族性、性自認および性別表現、経験レベル、国籍、個人の容姿、人種、信仰、性的同一性および指向に関わりなく、私たちのプロジェクトやコミュニティーへの参加を誰にとっても嫌がらせのない体験にすることを誓います。
 
 ## 私たちの標準
 
@@ -13,7 +13,7 @@ title: Gatsby コントリビューター行動規範
 - 友好的かつ男女包括用語の使用
 - 異なる観点や経験の尊重
 - 建設的批判の率直な受容
-- コミュニティにとっての最善への集中
+- コミュニティーにとっての最善への集中
 - 他のコミュニティメンバーへの共感
 
 参加者による容認できない行動の例：
@@ -32,15 +32,15 @@ title: Gatsby コントリビューター行動規範
 
 ## 適用範囲
 
-この行動規範は、個人がプロジェクトやそのコミュニティを代表するとき、プロジェクト内と公共空間の両方において適用されます。プロジェクトやコミュニティを代表する例として、プロジェクトの公式メールアドレスの使用、ソーシャルメディアの公式アカウント経由の投稿、指名された代表としてのオンラインやオフラインのイベントにおける行動があります。プロジェクトを代表することは、プロジェクトのメンテナーにより、さらに定義され明確化される可能性があります。
+この行動規範は、個人がプロジェクトやそのコミュニティーを代表するとき、プロジェクト内と公共空間の両方において適用されます。プロジェクトやコミュニティーを代表する例として、プロジェクトの公式メールアドレスの使用、ソーシャルメディアの公式アカウント経由の投稿、指名された代表としてのオンラインやオフラインのイベントにおける行動があります。プロジェクトを代表することは、プロジェクトのメンテナーにより、さらに定義され明確化される可能性があります。
 
 ## 執行
 
 暴言、嫌がらせ、またはそれ以外の受け入れられない行動は、[[email protected]](mailto:[email protected]) に連絡して、プロジェクトチームに報告される可能性があります。すべての苦情は、レビュー、調査され、必要かつ適切と判断された対応がとられます。プロジェクトチームは、事象の報告者に関する守秘義務があります。具体的な執行に関する詳細が別途設定されているかもしれません。
 
 この行動規範に誠意を持って従うことができない、または執行ができないプロジェクトのメンテナーは、プロジェクトをリードしている他のメンバーの判断により、一時的または恒久的な影響を受けることがあります。
 
-もし、再三の注意の後も悪質なコメントやハラスメントが継続する場合は、Gatsby チームはその方を Gatsby の Github のリポジトリから追放し、SNS 等でブロックする権利を留保します。この決定は必ず二人以上のチームメンバーの合意によって行われます。
+もし、再三の注意の後も悪質なコメントやハラスメントが継続する場合は、Gatsby チームはその方を Gatsby の Github のリポジトリーから追放し、SNS 等でブロックする権利を留保します。この決定は必ず二人以上のチームメンバーの合意によって行われます。
 
 ## 帰属
 

docs/docs/index.md

@@ -31,6 +31,6 @@ Gatsby に入門する方法は、大きく分けてふたつあります。
 
 ## 貢献する
 
-[貢献](/contributing/)セクションで、Gatsby コミュニティ、行動規範、そして Gatsby へ貢献する方法を見つけることができます。
+[貢献](/contributing/)セクションで、Gatsby コミュニティー、行動規範、そして Gatsby へ貢献する方法を見つけることができます。
 
 <EmailCaptureForm signupMessage="最新のTipsやトリックについて知りたいですか？私たちのニュースレターを購読しましょう！" />

docs/docs/quick-start.md

@@ -25,7 +25,7 @@ npm install -g gatsby-cli
 gatsby new gatsby-site
 ```
 
-### 生成されたディレクトリに移動する
+### 生成されたディレクトリーに移動する
 
 ```shell
 cd gatsby-site
@@ -39,7 +39,7 @@ gatsby develop
 
 Gatsby はホットリロード対応の開発環境を`localhost:8000`に立ち上げます。
 
-`src/pages`の中にある JavaScript で書かれたページを編集してみてください。保存された変更はブラウザ上でリアルタイムに反映されます。
+`src/pages`の中にある JavaScript で書かれたページを編集してみてください。保存された変更はブラウザー上でリアルタイムに反映されます。
 
 ### プロダクションビルドを作成する
 

docs/tutorial/index.md

@@ -11,7 +11,7 @@ Gatsby へようこそ！あなたがここにいることを嬉しく思いま
 
 0. [開発環境のセットアップ](/tutorial/part-zero/): Gatsby の力の源となるコアテクノロジーを紹介し、開発環境のセットアップを紹介します。
 1. [Gatsby の構成要素の理解](/tutorial/part-one/): 新しいプロジェクトを開始し、サイトを開発してデプロイします。
-1. [Gatsby で CSS を使用するための紹介](/tutorial/part-two/): Typography.js などのライブラリや CSS モジュールについて探索します。
+1. [Gatsby で CSS を使用するための紹介](/tutorial/part-two/): Typography.js などのライブラリーや CSS モジュールについて探索します。
 1. [Gatsby でネストしたレイアウトを構築](/tutorial/part-three/): レイアウトとは、ヘッダーやフッターなど、サイト内の複数のページで再利用されるセクションのことを指します。
 
 ## 中級チュートリアル

prh.yml

@@ -1,28 +1,7 @@
 version: 1
 rules:
-  - expected: エキスパート
-    pattern: エクスパート
-
-  - expected: コンピュータ
-    pattern: コンピューター
-
-  - expected: ブラウザ
-    pattern: ブラウザー
-
-  - expected: コミュニティ
-    pattern: コミュニティー
-
-  - expected: アクティビティ
-    pattern: アクティビティー
-
-  - expected: ユーザー
-    pattern: /ユーザ(?!ー)/
-
-  - expected: コミッター
-    pattern: /コミッタ(?!ー)/
-
-  - expected: コントリビューター
-    pattern: /コントリビュータ(?!ー)/
+  - expected: ステップ・バイ・ステップ
+    pattern: ステップバイステップ
 
   - expected: てみる
     pattern: て見る

style-guide.md

@@ -1,14 +1,14 @@
-# Style Guide
+# スタイルガイド
 
-Use this file for language-specific style rules to follow for translation.
+ドキュメントを日本語へ翻訳する際に参照すべきスタイルガイドです。内容の改定を提案したい場合は、Issue を立てるか、あるいは Discord で議論してください。
 
-## Rules
+## ルール
 
-### Text in Code Blocks
+### コードブロック内のテキスト
 
-Leave text in code blocks untranslated except for comments. You may optionally translate text in strings, but be careful not to translate strings that refer to code!
+コードブロック内については、コメントを除いて翻訳しないでください。任意で文字列リテラルの中身を翻訳しても良いですが、コードそのものはそのままにしてください！
 
-Example:
+例：
 
 ```js
 // Example
@@ -18,73 +18,97 @@ export default () => (
 )
 ```
 
-✅ DO:
+✅ 良い：
 
 ```js
-// Ejemplo
+// 例
 import React from "react"
 export default () => (
   <div style={{ color: `purple`, fontSize: `72px` }}>Hello Gatsby!</div>
 )
 ```
 
-✅ ALSO OKAY:
+✅ 良い：
 
 ```js
-// Ejemplo
+// 例
 import React from "react"
 export default () => (
-  <div style={{ color: `purple`, fontSize: `72px` }}>¡Hola Gatsby!</div>
+  <div style={{ color: `purple`, fontSize: `72px` }}>こんにちは、Gatsby！</div>
 )
 ```
 
-❌ DON'T:
+❌ 悪い：
 
 ```js
-// Ejemplo
+// 例
 import React from "react"
 export default () => (
-  // 'purple' is a CSS keyword
-  <div style={{ color: `morado`, fontSize: `72px` }}>¡Hola Gatsby!</div>
+  // 'purple' はCSSのキーワード
+  <div style={{ color: `紫`, fontSize: `72px` }}>こんにちは、Gatsby！</div>
 )
 ```
 
-❌ DEFINITELY DON'T:
+❌ 絶対にしないで：
 
 ```js
-importar Reaccionar desde "reaccionar"
-exportar defecto () => (
-   <div estilo = {{color: `morado`, fontSize:` 72px`}}> ¡Hola Gatsby! </div>
+インポート リアクト フロム "リアクト"
+エクスポート デフォルト () => (
+   <div スタイル={{color: `紫`, fontSize:` 72px`}}>こんにちは、Gatsby！</div>
 )
 ```
 
-### External Links
+### 外部リンク
 
-If an external link is to an article in a reference like [MDN] or [Wikipedia], and a version of that article exists in your language that is of decent quality, consider linking to that version instead.
+もし外部リンクが[MDN]や[Wikipedia]のような記事の場合であって、かつ十分なクオリティの日本語版が存在する場合は、翻訳版へのリンクを貼りましょう。
 
 [mdn]: https://developer.mozilla.org/en-US/
 [wikipedia]: https://en.wikipedia.org/wiki/Main_Page
 
-Example:
+例：
 
 ```md
 React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object).
 ```
 
-✅ OK:
+✅ 良い：
 
 ```md
-Los elementos de React son [inmutables](https://es.wikipedia.org/wiki/Objeto_inmutable).
+React エレメントは[イミュータブル](https://ja.wikipedia.org/wiki/イミュータブル)です。
 ```
 
-For links that have no equivalent (Stack Overflow, YouTube videos, etc.), just use the English link.
+同等のリンクが存在しない場合（Stack Overflow、YouTube 等）、英語リンクをそのまま使ってください。
 
-## Glossary
+### 文体
 
-Use this section to list how common technical terminology should be translated.
+敬体（ですます調）で、読者に直接語りかけるように書いてください。
 
-| Term   | Translation |
-| ------ | ----------- |
-| Plugin | ??          |
-| Theme  | ??          |
-| Query  | ??          |
+✅ 良い：
+
+```md
+もし React について詳しくなければ、まずは[こちらのガイド](https://reactjs.org)をご覧ください。
+```
+
+❌ ダメかも：
+
+```md
+React について詳しくない方は、まず[こちらのガイド](https://reactjs.org)を参照してください。
+```
+
+## 用語集
+
+頻出する用語は合意を得た上でリストに加えてください。さらに[prh.yml](/prh.yml)にルールを追加することで、CI にチェックを任せることができます。
+
+| 用語   | 和訳       |
+| ------ | ---------- |
+| Plugin | プラグイン |
+| Theme  | テーマ     |
+| Query  | クエリ     |
+
+## textlint
+
+`gatsby-ja`では文章の校正に textlint を活用しています。
+
+### `npm run lint`
+
+`npm run lint`を実行して、ローカルで textlint による校正を受けることができます。ほとんどのエラーは`npm run format`を実行することで自動修正できます。