/Nextjs-ja-translation-docs

(Unofficial) Japanese transition of Next.js documentation

Primary LanguageJavaScriptMIT LicenseMIT

Nextjs-ja-translation-docs

All Contributors

reviewdog

Next.js のドキュメントを翻訳する非公式プロジェクトです。

本家公式ドキュメント

本家ドキュメントへの追従方針

  • 本家で新規作成されたファイルは追加する
  • 未翻訳のファイルが本家で更新されていたら更新する
  • 翻訳の有無関わらず本家で削除されたファイルは削除する
  • // #TODO: 翻訳済ファイルの追従方針を決める

翻訳手順

翻訳の状況は、翻訳の概要と進捗状況の issues を確認してください。

手順1:翻訳を始める準備

まずは、このリポジトリを右上から Fork してください。

そして、リポジトリをクローンします。yourには、あなたの GitHub のユーザーネームを入れてください。

$ git clone https://github.com/your/Nextjs-ja-translation-docs
$ cd Nextjs-ja-translation-docs

dependency のインストールをしてください。必ず yarn で行ってください。

$ yarn install

開発サーバーが無事に起動するか確認してください。

$ yarn dev

翻訳作業を行うためのブランチを作成します。ここでは、例として docs/example.md を翻訳するためのブランチを作成します。

$ git checkout -b docs/example

これで、翻訳を始める準備は完了です。エディタを使って、翻訳箇所のファイルを編集します。

また、docs/manifest.json の各セクションのタイトルが設定されています。自分の担当箇所のタイトルを翻訳してください。

getting-started を翻訳する例:

{ "title": "はじめに", "path": "/docs/getting-started.md" },

手順2:翻訳完了からプルリクエスト

precommit 時に翻訳の対象ファイルに対して textlint が走ります。textlint が通らない限り commit できません。エラーを修正する場合は、text-lint:fixを使います。

$ yarn text-lint:fix ./docs/example.md

翻訳箇所をコミットしてプッシュします。コミットはできるだけ 1 つにまとめてください。

$ git add .
$ git commit -m "docs: translate docs/example.md"
$ git push -u origin docs/example.md

最後に、GitHub 上からプルリクエストを作成してください。その後、メンテナーがレビューをして問題がなければマージされます。

Q&A

質問がある場合は、Slackに参加して、#questions チャンネルまでお願いします。

Contributors ✨

Thanks to these wonderful people (emoji key):


Shinobu Hayashi

💻 👀 🔧

かみむら

💻 👀 🌍

hoosan

🌍 📖 👀

Daiki Okumura

🌍

yokinist

📖 🌍 🔧 👀

kurosawa

🌍

Noriaki UCHIYAMA

🌍

ria

🌍

ryuckel

🌍

Okuto Oyama

🌍

syakoo

🌍

thesugar / Ryohei Sato

👀 🌍

Yuji Matsumoto

🌍

Teruhisa Fukumoto

🌍

Takefumi Yoshii

🌍

rikusen0335

🌍

Kentaro Suzuki

🌍

ogugu

🌍

Yuki Takemoto

🌍

Kiichi Tachibana

🌍

ken_o

🌍

Mashu Kushibiki

🌍

Masaki Yoshiiwa

🌍

Kazuki Furukawa

🌍

Atsusuke

🌍

dmamira

🌍

Kyohei Oka

🌍

ともたこ(Tomotaka Ogino)

🌍

Tomo

🌍

ryu-sou

🌍

tanakaKSUK

🌍

adoringonion

🌍

chiiita

🌍

Hiroshi Ito

📖

Keeth Kuwahara

🌍

Hiroki.Ihoriya

🌍

Hirofumi Wakasugi

👀

numb86

🐛

Hiroshi MORISHIGE

🌍

shinya fukimbara

🌍

yodaka

🌍

Kazuhiro-Mimaki

🌍

Piyopanman

🌍

Tetsuya Negishi

🌍