環境構築方法
- Forkボタンからこのリポジトリをフォークする
git clone
を用いて、Forkしたリポジトリをクローンする
- クローンしてきたフォルダーに入って、
yarn install
を実行して開発に必要なライブラリをインストールする
yarn dev
を実行して、http://localhost:3000
にアクセスしてドキュメントページが表示されているか確認する
翻訳の手順
※ 環境構築は既に行っている事を前提に書いてきます。
1. Issuesから貢献したいIssueを探す
上記のURLから取り組みたいIssueを探して、翻訳する旨のコメントをして下さい。
コメントの例
2. 最新の変更からブランチを切る
このリポジトリの最新のdevelop
から、ブランチを切って作業してください。
ブランチ名は任意ですが、Issue番号を含めることをオススメします。
最新の変更からブランチを切る例
$> # sshの場合
$> git remote add upstream [email protected]:uttk/swr-site.git
$> # httpsの場合
$> git remote add upstream https://github.com/uttk/swr-site.git
$> # このリポジトリの変更を取得する
$> git fetch upstream
$> # このリポジトリの変更を取り込む
$> git merge upstream/develop
$> # トップページ(#8)の場合、以下のようなブランチ名で切る
$> git checkout -b docs/#8_translate_top_page
3. 翻訳する
翻訳ページの作り方は既に簡体語のページがありますので、それに倣って ○○.ja.mdx
と言うファイルを作成し、そのファイルに日本語の翻訳を記述してください。
タイトルの例
またPRを取り込むときにはSquash and mergeされるので、コミットに制限などはありません。
コミット内容に問題なければ、好きなようにコミットをして大丈夫です。
4. PRを出す
Pull Requestを出す時は、このリポジトリ(uttk/swr-site)のdevelop
ブランチに宛て出してください。
Pull Requestのタイトルは分かりやすいモノにして下さい。
タイトルの例
Pull Requestの内容には、具体的な作業内容を書いてください。
校正者のためにも、翻訳時に気になった部分などは共有するようにして下さい。
作業内容の例
トップページを翻訳しました。
「 ○○ 」の部分は、「 □□ 」と言う翻訳にしました。
理由は、直訳すると分かりにくいからです。
5. 校正担当者をreviewerに設定する
上記の記事を参考に、校正担当者をreviewerに指定してください。
※ 担当者がいない場合は、@uttkをreviewerに指定してください。
6. 校正を受ける
校正担当者から指摘があった場合は、お互いに議論し必要があれば修正してください。
7. マージの確認
特に問題が無ければマージされますので、それが確認出来たら翻訳が完了です🎉
注意点など
- ブランチ名は任意ですが、Issue番号を含めることをオススメします。( 例:
feature/#8_translate_top_page
)
- PRを出す際は、reviewerを必ずつけて下さい。
- 担当者がいなければ@uttkを指定し、校正Issueに募集のコメントなどして下さい。