Coder Social home page Coder Social logo

swr-site's Issues

参加表明🙋‍♀️🙋‍♂️

概要

翻訳活動の参加表明をするためのissueです。
参加される際は、以下のようにして表明してください。

※ ページを指定する際は、既に指定されているページとは被らないようにお願いします🙏
※ 特にページの指定などが無い場合は、その事を明記して下さい。その場合、こちらでページを割り振る事があります。予めご了承ください💁‍♂️💁‍♀️

翻訳の場合

この翻訳プロジェクトに参加したい xxx です。○○のページの翻訳がしたいです。

## ○○のページ

- [ ここに翻訳したいページのリンク ]( リンク )

校正の場合

この翻訳プロジェクトに参加したい xxx です。○○のページの校正がしたいです。

## ○○のページ

- [ ここに校正したいページのリンク ]( リンク )

注意事項

現在( 2021/04/05 )、環境構築が整ってないので、それが整い次第このissueへ参加表明して頂いた方へメンションさせて頂きます。予めご了承ください🙏

また、環境構築について知見や意見をお持ちの方は、以下のissueへの参加をお願いします🙇‍♂️🙇‍♀️

#2

宜しくお願い致します🤝

翻訳対応表

概要

翻訳するページの対応表をまとめます。

対応表

貢献方法について

注意

このissueでは翻訳の進め方を定義していきますが、載っている情報はあくまで暫定的に決定されたモノであり、プロジェクトの進捗状況によって変更されることに注意してください！

基本的な流れ

  1. このリポジトリのIssuesから貢献したいIssueを探す
  2. 貢献したいIssueが見つかったら、貢献したい旨のコメントをそのIssueに記述する
  3. 担当するIssueの内容を実施する。( Issueにコメントしていれば、特に確認等は必要ない )
  4. マージされたら完了です🎉

翻訳の手順について

#45 を参照してください。

構成の手順について

#46 を参照してください。

注意点

取り組むIssueについて

  • 翻訳者募集中・校正者募集中 のラベルが付いているIssueから取り組むようにして下さい
  • 既に担当する旨のコメントが記載されているIssueは取り組まないようにして下さい
  • 取り組む際は必ずIssueにコメントしてから、取り組んでください

議論

#41

ページ全体の表記ゆれのチェック項目を策定する

概要

全てのページの翻訳が完了した時に、全体を通して表記ゆれが無いかチェックする。
チェックする項目は、以下のチェックリストの内容を実施する。

チェックリスト

  • ひらがな書きが適切なモノが漢字で表記されている場合、ひらがな書きに直す( 参照 )
  • ひとつ, ふたつ, みっつ など表現は、一つ, 二つ, 三つ のような漢数字を用いて表現する
  • return value の翻訳は 返り値 とする ( 戻り値 となっている所は、返り値に修正する )
  • リンクとの間には半角スペースを入れる( **語翻訳と同じようにする )

随時追記していきます🖊
提案が有れば、お気軽にコメントして下さい💁‍♂️💁‍♀️

翻訳・校正の時に参考になる資料をまとめる

概要

翻訳・校正の時に参考となる資料をまとめます。
注意として、ここでまとめた資料の内容を強制する意図はありません。

資料一覧

翻訳の手順について

環境構築方法

  1. Forkボタンからこのリポジトリをフォークする
  2. git clone を用いて、Forkしたリポジトリをクローンする
  3. クローンしてきたフォルダーに入って、yarn install を実行して開発に必要なライブラリをインストールする
  4. 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に募集のコメントなどして下さい。

校正の手順について

構成の手順

1. Issuesから貢献したいIssueを探す

上記のURLから取り組みたいIssueを探して、翻訳する旨のコメントをして下さい。

コメントの例

このページを構成します。

2. レビュー機能を使って構成する

校正担当の翻訳Pull Requestが上がってきたら、githubのreview機能を使って校正して下さい。

翻訳に不備や問題があった場合

校正してみて、翻訳の内容に問題があった場合は、[ Request changes ] で、翻訳者にその旨のコメントをして下さい。

※ 提案などは、 [ Comment ] でお願いします。

[ Request changes ]の参考画像

image

参考

3. 校正が完了したらコメントする

校正が完了したら [ Approve ] で reviewを終了し、その旨のコメントをして下さい。
またコメントする際、@uttkを付けてコメントしてください。
@uttk が確認後、問題が無ければマージします。

[ Approve ]の参考画像

image

公式サイトへ統合できるか確認する

元々公式サイトとは別のサイトを作って、そこに翻訳したページを載せるつもりだったけど、公式サイトに**語の翻訳が既にあるので、この際日本語も一緒に載せてもらった方が良さそう。

なので、このリポジトリのフォーク元に統合できないかの確認を取る。

提案： 原文をコピーして入れておく

提案内容

事前に *.en-US.md をコピーした *.ja.md を master に入れておくと良いのではないでしょうか。

理由

PR #48 を作成して気付いたのですが、事前に *.en-US.md をコピーした *.ja.md を master に入れておくと、PR を出したときに原文との差分が PR 上で見れるのでレビューしやすくなると思います。

e.g.

-The context `SWRConfig` can provide global configurations ([options](/docs/options)) for all SWR hooks.
+コンテキスト `SWRConfig` によって、すべての SWR フックに対するグローバルな設定 ([オプション](/docs/options)) を提供できます。

カタカナ・ひらがなにするべき用語をまとめる

概要

表記揺れをチェックするために、カタカナ・ひらがなにするべき用語をまとめたいと思います。
抜けているところなどがありましたら、ご指摘頂けると幸いです🙇‍♂️

注意するべき専門用語の翻訳対応表

翻訳する際に注意するべき単語を以下に列挙していきます。

※ 専門用語は基本的にカタカナに翻訳する( 参照 )。
※ React公式ドキュメント などの参考文献を参考にする場合や、文脈によってカタカナが不適合な場合は、この限りではありません。

原文 翻訳文 参照
render/rendering レンダリング #70 (comment)
parse パース #69 (comment)
return value(s) 返り値 #67 (comment)
response レスポンス なし
hydration 再利用 #65 (comment)
Suspense サスペンス #60 (comment)
mutation ミューテーション #58 (comment)
mutate ミューテート #58 (comment)
fetch フェッチ なし
fetcher フェッチャー なし
Hook(s) フック なし
Polyfill ポリフィル なし
Error Boundary エラーバウンダリー なし

ひらがなにするべき単語

基本的には 実践テクニカルライティングセミナー－マニュアル作成の進め方とわかりやすいマニュアルのポイント－ の内容に沿って ひらがな にします。

また上記のサイトに載っていないが、ひらがな にした方が良いと判断したモノは以下に示します。

漢字 ひらがな
出来る できる
基づいて もとづいて
事( が/も ) こと( が/も )
( ～が/の )無い ( ～が/の )ない

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.