Nextjs-ja-translation-docs
Next.jsのドキュメントを翻訳する非公式プロジェクトです。
翻訳手順
翻訳の状況は、翻訳の概要と進捗状況の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.md
これで、翻訳を始める準備は完了です。エディタを使って、翻訳箇所のファイルを編集します。
また、docs/manifest.jsonの各セクションのタイトルが設定されています。自分の担当箇所のタイトルを翻訳してください。
getting-staredを翻訳する例:
{ "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 |
syakoo |