Skip to content

Latest commit

 

History

History
198 lines (120 loc) · 9.93 KB

CONTRIBUTING_ja.md

File metadata and controls

198 lines (120 loc) · 9.93 KB

Svelte Site JP への貢献について

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

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

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

貢献するには

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

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

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

翻訳作業について

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

最近 Svelte のサイトの構成が変わったため、ここに記載されているディレクトリ構成の情報は古くなっております。 修正されるまで、しばらくお待ち下さい。

ドキュメントのファイルはこのリポジトリの site/content ディレクトリにあります。

  • Blog
    • Blogは site/content/blog 配下にあります。
  • Docs
    • Docsは site/content/docs 配下にあります。
  • FAQ
    • FAQは site/content/faq 配下にあります。
  • チュートリアル
    • チュートリアルは site/content/tutorial 配下のそれぞれの章ごとにtext.mdというファイルがあります。
site
├── content
│   ├── blog
│   │   ├── 2016-11-26-frameworks-without-the-framework.md  # <- Blog
│   │   ...
│   │
│   ├── docs
│   │   ├── 00-introduction.md        # <- Docs
│   │   ...
│   │
│   ├── examples
│   ├── faq
│   │   ├── 100-im-new-to-svelte.md   # <- FAQ
│   │   ...
│   │
│   └── tutorial
│       ├── 01-introduction
│       │   ├── 01-basics
│       │   │   ├── app-a
│       │   │   └── text.md   # <- チュートリアル
│       ...
│
etc...

サイトのソース、TOPページの日本語訳は svelte-jp/site にあります。

翻訳の流れ

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

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

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

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

もし翻訳したいドキュメントのIssueがなければ、Issueを作成してください。

2. 翻訳作業

このリポジトリをForkし、ローカルにcloneしてください。

git clone https://github.com/{USER}/svelte-site-jp.git

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

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

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

2-1. ブログの翻訳について

ブログ記事は長文になることが多く、opinionatedな意見もあり、言い回しや誤訳によって誤解を招く可能性があります。
オリジナルの著者の方にご迷惑をかけるのを防ぐ目的で、翻訳された文書であることを特に強調するために下記のテンプレートを追記してください。

> 翻訳 : Svelte日本コミュニティ  
> 原文 : https://svelte.dev/blog/sveltekit-beta
> 
> 日本語版は原文をよりよく理解するための参考となることを目的としています。  
> 正確な内容についてはsvelte.devの原文を参照してください。  
> 日本語訳に誤解を招く内容がある場合は下記のいずれかからお知らせください。
> - [svelte-jp/svelte-site-jp(GitHub)](https://github.com/svelte-jp/svelte-site-jp)
> - [Svelte日本(Discord)](https://discord.com/invite/YTXq3ZtBbx)

見本： https://raw.githubusercontent.com/svelte-jp/svelte-site-jp/master/site/content/blog/2021-03-23-sveltekit-beta.md

3. lintの実行

lintを実行し、引っかかった箇所は修正してください。

npm run textlint

終わったらcommitし、Fork先にpushします。

4. Pull Request作成

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

翻訳スタイル

翻訳のガイドライン

「公用文作成の要領」の見直しに関する国語課題小委員会の検討状況（案）

文体

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

改行位置を原文と揃える

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

単語、表記ゆれ

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

ダッシュ

原文で使われているダッシュは、以下のように場合に応じて訳し分けてください。

  • 和訳で文中に埋め込まれるような語句を区切っている場合、ダッシュの代わりに括弧でその語句を囲んでください
  • 和訳で文と文の区切りになっている場合、ダッシュの代わりに句点（。）を打ってください
  • 箇条書きの項目と説明を区切っている場合、ダッシュをそのままにする

Issueを作成する

何かお気づきの点などがある場合はお気軽にIssueを作成して頂いて構いません。 以下のテンプレートを用意しております。

  • 翻訳ドキュメント追加
    • 翻訳したい/してほしいドキュメントがIssueになければこちらをご使用ください。
  • 誤字・脱字・誤訳報告、翻訳改善要望
    • 誤字・脱字・誤訳や、不自然な言い回しやよりより翻訳文があればこちらをご使用ください。
  • その他
    • ご質問、ご意見、お気軽にどうぞ！

その他

  • Svelte本体の変更は大体月に1度のペースで日本語サイトにも反映を行います。これは、Svelte本体のサイトが大体月に1度(月初、毎月のNewsletterが入るタイミング)で更新されるためです。 Svelte本体のサイトに緊急で更新がある場合はなるべくそれに追従したいと考えています。

備考

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

ライセンス

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

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