Skip to content

Latest commit

 

History

History
171 lines (116 loc) · 9.14 KB

CONTRIBUTING.md

File metadata and controls

171 lines (116 loc) · 9.14 KB

Svelte Site JP への貢献について

Svelte Site JPはSvelte公式ドキュメントサイトの日本語化プロジェクトです。 Svelteは素晴らしいツールで、公式ドキュメント及びチュートリアルも非常に素晴らしいです。公式からは英語版のみ提供されていますが、日本語に翻訳されたドキュメントとチュートリアルがあれば日本語話者にとってはもっと学習しやすくなると考えています。

このリポジトリはsveltejs/svelteのsiteディレクトリをフォークして作成されており、ライセンスやコミュニティ・コラボレーションの精神についてはSvelte本体のそれを引き継ぎます。

Svelte公式のCONTRIBUTING.mdはこちらです、是非ご一読ください。

貢献するには

Svelte Site JPに貢献する方法はたくさんあり、その多くはコードを書く必要もなければ、いきなり翻訳する必要もありません。

  • 日本語化されたドキュメントサイトを使ってみてください。気になるところや改善点があればIssueを開いてお知らせください。
  • 翻訳にはみなさんの協力が必要です。翻訳に興味があれば翻訳作業についてをチェックしてみてください。完璧な翻訳は望んでいません。誤訳があっても誤字・脱字があっても単語が統一できていなくても構いません、後からみんなで良くしていければと考えています。

貢献は大歓迎です。もし貢献を迷っていたり、貢献に助けが必要であればSvelte日本のDiscordで知らせてください。

翻訳作業について

ディレクトリ構成・翻訳の仕組み

  • Blog
    • Blogの原文は content/blog 配下にあります。
      日本語翻訳は content/blog/ja 配下の {原文のファイル名}.ja.md というファイルを修正して行います。
  • API Docs
    • API Docsの原文は content/docs 配下にあります。
      日本語翻訳は content/docs/ja 配下の {原文のファイル名}.ja.md というファイルを修正して行います。
  • FAQ
    • FAQの原文は content/faq 配下にあります。
      日本語翻訳は content/faq/ja 配下の {原文のファイル名}.ja.md というファイルを修正して行います。
  • チュートリアル
    • チュートリアルの原文はcontent/tutorial配下のそれぞれの章ごとにtext.mdというファイルから読み取られています。 日本語翻訳は、そのtext.mdをコピーしてtext.ja.mdというファイルを作成して文章を翻訳します。
      (text.ja.mdはホットリロードだと変更が反映されないのでご注意ください！)
  • トップページ
    • トップページはmessages配下のen.jsonが原文で、日本語翻訳はja.jsonファイルです。
  • Chat(Discord)のリンク
    • Svelte本体のDiscordのリンクはsrc/routes配下のchat.jsにあり、Svelte日本Discordのリンクはchat-jp.jsにあります。
.
├── content
│   ├── blog
│   │   ├── 2016-11-26-frameworks-without-the-framework.md         # <- Blogの原文
│   │   ...
│   │   └── ja
│   │       ├── 2016-11-26-frameworks-without-the-framework.ja.md  # <- Blogの日本語翻訳用ファイル
│   │       ...
│   │
│   ├── docs
│   │   ├── 00-introduction.md         # <- API Docsの原文
│   │   ...
│   │   └── ja
│   │       ├── 00-introduction.ja.md  # <- API Docsの日本語翻訳用ファイル
│   │       ...
│   │
│   ├── examples
│   ├── faq
│   │   ├── 100-im-new-to-svelte.md         # <- FAQの原文
│   │   ...
│   │   └── ja
│   │       ├── 100-im-new-to-svelte.ja.md  # <- FAQの日本語翻訳用ファイル
│   │       ...
│   │
│   └── tutorial
│       ├── 01-introduction
│       │   ├── 01-basics
│       │   │   ├── app-a
│       │   │   ├── text.ja.md  # <- チュートリアルの日本語翻訳用ファイル
│       │   │   └── text.md     # <- チュートリアルの原文
│       ...
...
├── messages
│   ├── en.json           # <- トップページの英語ファイル
│   └── ja.json           # <- トップページの日本語ファイル
...
├── src
│   ├── routes
│   │   ...
│   │   ├── index.svelte  # <- トップページ
│   │   ...
│   │   ├── chat-jp.js  # <- Svelte日本Discordへのリンク
│   │   ├── chat.js     # <- SvelteDiscordへのリンク
│   │   ...
etc...

翻訳の流れ

1. 翻訳するドキュメントを選ぶ

翻訳が必要な文書はIssueが作成されています。

まだ誰も着手していないIssueには翻訳者募集中というLabelがついています。翻訳したいものがあれば、Issueのコメントで知らせてください(堅苦しい挨拶などは不要です。「この翻訳やりましょうか？」と言っていただけたらそれだけでとても嬉しいです！)。

運営側から依頼する旨をコメントで返信しますので、その後に作業を開始してください。

2. 環境設定

このリポジトリをForkし、セットアップしてください。

git clone https://github.com/{USER}/svelte-site-jp.git
cd svelte-site-jp
npm ci
npm run update
npm run dev

このあとlocalhost:3000にアクセスし、正常に表示されることを確認します。

3. 翻訳作業

ディレクトリ構成・翻訳の仕組みを参考に、担当する文書を見つけてください。

実際の翻訳については翻訳のガイドラインを参考にしてください。

いきなり完璧な翻訳を目指さなくても大丈夫です。PRに間違いや誤字・脱字があっても大丈夫です。ちゃんとレビューをしますし、レビューで怒ったりしませんのでご安心ください。それより、あなたがこのプロジェクトに貢献するため時間と労力を割いてくれたことに感謝しかありません。

翻訳ができたらcommitし、Fork先にpushします。

4. Pull Request作成

Fork元にPull Requestを提出してください。Pull RequestのコメントにはIssueの番号を含めてください。レビュー後、問題がなければマージされます。何度も言いますが、PRに間違いや誤字・脱字、ガイドライン違反があっても大丈夫です。間違いを恐れないでください。

翻訳のガイドライン

文体

「だである」ではなく「ですます」調を使用してください。

改行位置を原文と揃える

可能な限り、原文と翻訳文の行数を揃え、更新時のdiffチェックが楽になるように協力してください。

単語、表記ゆれ

DICTIONARY.mdを参考にしてください。

Issueを作成する

申し訳ありません、まだIssueを作成するためのテンプレートやガイドラインを準備できておりません。
何かお気づきの点などがあってIssueを作成される場合は、ご自由に記載頂いて大丈夫です。
例えば翻訳で不自然なところがあれば「〇〇の翻訳が不自然です」だけでもいいですし、良い言い回しや正しい翻訳があれば「{良い言い回し・正しい翻訳}ではどうですか」くらいで構いません。

備考

翻訳の進め方やCONTRIBUTING.mdに記載する内容などは、各フロントエンドフレームワーク及びライブラリの日本語化プロジェクトである、angular/angular-ja、vuejs /jp.vuejs.org, reactjs/ja.reactjs.orgを参考にさせて頂きました。

ライセンス

Svelte Site JPはsveltejs/svelteのsiteディレクトリをフォークして作成されており、ライセンス(MIT)を引き継いでいます。

Svelte Site JPに貢献することにより, あなたはあなたの貢献がMIT licenseの下でライセンスされることに同意するものとします。