ドキュメントを日本語へ翻訳する際に参照すべきスタイルガイドです。内容の改定を提案したい場合は、Issue を立てるか、あるいは Discord で議論してください。
原文をなるべく忠実に翻訳したいという気持ちが先行してしまい、直訳のような文章になってしまうことがあります。意訳を恐れず、日本語として自然な文章を心掛けましょう。
コードブロック内に関しては、基本的にコメント以外を翻訳しないでください。任意で文字列リテラルの中身を翻訳することはできますが、コード自体はそのままにしてください！
例：
// Example
import React from "react"
export default () => (
<div style={{ color: `purple`, fontSize: `72px` }}>Hello Gatsby!</div>
)✅ 良い：
// 例
import React from "react"
export default () => (
<div style={{ color: `purple`, fontSize: `72px` }}>Hello Gatsby!</div>
)✅ 良い：
// 例
import React from "react"
export default () => (
<div style={{ color: `purple`, fontSize: `72px` }}>こんにちは、Gatsby！</div>
)❌ 悪い：
// 例
import React from "react"
export default () => (
// 'purple' はCSSのキーワード
<div style={{ color: `紫`, fontSize: `72px` }}>こんにちは、Gatsby！</div>
)❌ 絶対にしないで：
インポート リアクト フロム "リアクト"
エクスポート デフォルト () => (
<div スタイル={{color: `紫`, fontSize:` 72px`}}>こんにちは、Gatsby！</div>
)もし外部リンクがMDNやWikipediaのような記事の場合であって、かつ十分なクオリティの日本語版が存在する場合は、翻訳版へのリンクを貼りましょう。
例：
React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object).✅ 良い：
React エレメントは[イミュータブル](https://ja.wikipedia.org/wiki/イミュータブル)です。同等のリンクが存在しない場合（Stack Overflow、YouTube 等）、英語リンクをそのまま使用してください。
敬体（ですます調）を使って、読者に一対一で語りかけるように書いてください。
✅ 良い：
もし React について詳しくなければ、まずは[こちらのガイド](https://reactjs.org)をご覧ください。❌ ダメかも：
React について詳しくない方は、まず[こちらのガイド](https://reactjs.org)を参照してください。ある程度まとまった文章になっている場合は「敬体」、それ以外は「体言止め」を使用します。体言止めの場合は文末の句点を省略します。
✅ 良い：
コンピュータに Homebrew をインストールするには:
1. ターミナルを開きます。
1. `brew -v`を実行して Homebrew がインストールされているか確認します。"Homebrew"という文字列とバージョン番号が表示されるはずです。
1. もし表示されない場合は、[Homebrew の指示](https://docs.brew.sh/Installation)に従って、ダウンロードしてインストールします。
1. Homebrew をインストールしたら、手順 2 を繰り返して確認します。✅ 良い：
たとえば、プラグインを使うことで以下のようなことができます。
- 外部データまたはコンテンツの取得
- データの変換頻出する用語は合意を得た上でリストに加えてください。さらにprh.ymlにルールを追加することで、CI にチェックを任せることができます。
| 用語 | 和訳 |
|---|---|
| Gatsby.js, GatsbyJS | Gatsby |
| Plugin | プラグイン |
| Theme | テーマ |
| Query | クエリー |
| contribute, contribution | 貢献 |
| swag | 景品 |
| issue | Issue |
| pull request | Pull Request |
| intro, introduction | はじめに |
gatsby-jaでは文章の校正に textlint を活用しています。どのようなルールがあるのか知りたい場合は.textlintrc.jsを見てください。
npm run lintを実行して、ローカルで textlint による校正を受けることができます。ほとんどのエラーはnpm run formatを実行することで自動修正できます。
各言語版のリポジトリーには画像アセットが含まれていないため表示されない仕様になっています。
Gatsby でプレビューをする前提で書かれているため、生の Markdown から飛ぶと 404 が表示されます。ブラウザー上で URL の末尾に.mdをつけることで正しい記事に移動できます。