svelte-jp/kit は SvelteKit ドキュメントサイトの日本語化プロジェクトです。
このリポジトリはsveltejs/kitをフォークして作成されており、ライセンスやコミュニティ・コラボレーションの精神についてはFork元を引き継ぎます。
Svelte本体のドキュメントの日本語化プロジェクトのリポジトリは svelte-jp/svelte-site-jp です。
SvelteKitドキュメントの日本語翻訳に貢献する方法はたくさんあり、その多くはコードを書く必要もなければ、いきなり翻訳する必要もありません。
- 日本語ドキュメントサイト(https://kit.svelte.jp/)を使ってみてください。気になるところや改善点があればIssueを開いてお知らせください。
- 翻訳で貢献されたい場合は翻訳作業についてをチェックしてみてください。翻訳にはみなさんの協力が必要です。誤訳があっても誤字・脱字があっても単語が統一できていなくても構いません、後からみんなで良くしていければと考えています。
貢献は大歓迎です！もし貢献を迷っていたり、助けが必要であればSvelte日本のDiscordで知らせてください。
ドキュメントのファイルはこのリポジトリの documentation ディレクトリにあります。
- Docs
- Docsは documentation/docs 配下にあります。
- FAQ
- FAQは documentation/faq 配下にあります。
documentation
├── docs
│ ├── 00-introduction.md # <- Docs
│ ...
│
└── faq
├── 00-other-resources.md # <- FAQ
...
サイトのソース、TOPページの日本語訳は sites/kit.svelte.dev ディレクトリにあります。
翻訳が必要なドキュメントはIssueが作成されています。
まだ誰も着手していないものには翻訳者募集中というLabelがついています。翻訳したいものがあれば、Issueのコメントで知らせてください(堅苦しい挨拶などは不要で、「この翻訳やりましょうか？」と言っていただければOKです！)。
運営側から依頼する旨をコメントで返信しますので、その後に作業を開始してください。
もし翻訳したいドキュメントのIssueがなければ、Issueを作成してください。
このリポジトリをForkし、ローカルにcloneしてください。
git clone https://github.com/{USER}/kit.git
ドキュメントのディレクトリ構成を参考に、翻訳するドキュメントを見つけてください。
翻訳スタイルについては翻訳スタイルを参考にしてください。
いきなり完璧な翻訳を目指さなくても大丈夫です。PRに間違いや誤字・脱字があっても大丈夫です。ちゃんとレビューをしますし、レビューで怒ったりしませんのでご安心ください。それより、あなたがこのプロジェクトに貢献するため時間と労力を割いてくれたことに感謝しかありません。
lintを実行し、引っかかった箇所は修正してください。
npm run textlint
終わったらcommitし、Fork先にpushします。
Fork元にPull Requestを提出してください。Pull RequestのコメントにはIssueの番号を含めてください。レビュー後、問題がなければマージされます。 PRに間違いや誤字・脱字、ガイドライン違反があっても大丈夫です。間違いを恐れないでください。
svelte-jp/svelte-site-jp の「翻訳スタイル」 をご参照ください。
このリポジトリは sveltejs/kit をフォークして作成されており、ライセンス(MIT)を引き継いでいます。
このリポジトリに貢献することにより、あなたはあなたの貢献がMIT licenseの下でライセンスされることに同意するものとします。