Svelte Site JPはSvelte公式ドキュメントサイトの日本語化プロジェクトです。 Svelteは素晴らしいツールで、公式ドキュメント及びチュートリアルも非常に素晴らしいです。公式からは英語版のみ提供されていますが、日本語に翻訳されたドキュメントとチュートリアルがあれば日本語話者にとってはもっと学習しやすくなると考えています。
このリポジトリはsveltejs/svelteのsiteディレクトリをフォークして作成されており、ライセンスやコミュニティ・コラボレーションの精神についてはSvelte本体のそれを引き継ぎます。
Svelte公式のCONTRIBUTING.mdはこちらです、是非ご一読ください。
Svelte Site JPに貢献する方法はたくさんあり、その多くはコードを書く必要もなければ、いきなり翻訳する必要もありません。
- 日本語化されたドキュメントサイトを使ってみてください。気になるところや改善点があればIssueを開いてお知らせください。
- 翻訳にはみなさんの協力が必要です。翻訳に興味があれば翻訳作業についてをチェックしてみてください。完璧な翻訳は望んでいません。誤訳があっても誤字・脱字があっても単語が統一できていなくても構いません、後からみんなで良くしていければと考えています。
貢献は大歓迎です。もし貢献を迷っていたり、貢献に助けが必要であればSvelte日本のDiscordで知らせてください。
チュートリアルの原文はcontent/tutorial配下のそれぞれの章ごとにtext.mdというファイルから読み取られています。日本語翻訳は、そのtext.mdをコピーしてtext.ja.mdというファイルを作成して文章を翻訳します。
(text.ja.mdはホットリロードだと変更が反映されないのでご注意ください！)
.
├── content
│ ├── blog
│ ├── docs
│ ├── examples
│ ├── faq
│ └── tutorial
│ ├── 01-introduction
│ │ ├── 01-basics
│ │ │ ├── app-a
│ │ │ ├── text.ja.md # ←日本語翻訳 原文をコピーして作成
│ │ │ └── text.md # ←原文
etc...
※チュートリアル以外の翻訳は準備中です。
翻訳が必要な文書はIssueが作成されています。
まだ誰も着手していないIssueには翻訳者募集中というLabelがついています。翻訳したいものがあれば、Issueのコメントで知らせてください(堅苦しい挨拶などは不要です。「この翻訳やりましょうか？」と言っていただけたらそれだけでとても嬉しいです！)。
運営側から依頼する旨をコメントで返信しますので、その後に作業を開始してください。
このリポジトリを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にアクセスし、正常に表示されることを確認します。
ディレクトリ構成・翻訳の仕組みを参考に、担当する文書の翻訳を行います。いきなり完璧な翻訳を目指さなくても大丈夫です。
翻訳ができたらcommitし、Fork先にpushします。
Fork元にPull Requestを提出してください。Pull RequestのコメントにはIssueの番号を含めてください。レビュー後、問題がなければマージされます。
申し訳ありません、まだIssueを作成するためのテンプレートやガイドラインを準備できておりません。
何かお気づきの点などがあってIssueを作成される場合は、ご自由に記載頂いて大丈夫です。
例えば翻訳で不自然なところがあれば「〇〇の翻訳が不自然です」だけでもいいですし、良い言い回しや正しい翻訳があれば「{良い言い回し・正しい翻訳}ではどうですか」くらいで構いません。
翻訳の進め方やCONTRIBUTING.mdに記載する内容などはAngularの日本語化プロジェクトであるangular-jaを参考にさせて頂きました。
Svelte Site JPはsveltejs/svelteのsiteディレクトリをフォークして作成されており、ライセンス(MIT)を引き継いでいます。
Svelte Site JPに貢献することにより, あなたはあなたの貢献がMIT licenseの下でライセンスされることに同意するものとします。