メインコンテンツまでスキップ

Floorp Docs 貢献ガイドライン

Floorp のドキュメントの改善に関心をお寄せいただき、ありがとうございます!
貢献する前に、既存のコンテンツや未解決の Issue を読み、その内容でお間違いがないことを今いちどご確認ください。

さまざまな貢献方法

コンテンツを追加する

新しい文章を書く前に、その内容がすでにドキュメントに存在していないか確認してみましょう。もし存在するなら、重複したものを作成するのではなく、既存の内容を改善することをご検討ください。
新しいドキュメントを追加する場合は、それを読むユーザーと開発者の両方が自然に理解できる内容を心がけましょう。

問題を解決する

ドキュメントに間違いを見つけた場合は、何が間違っているのかを分かりやすく説明した新しい Issue を開いて報告するか、自分でそれを修正し、Pull Request を通じて提出することができます。
修正を提出する際は、関連する Issue への言及をお忘れなく。

問題を解決するには:

  1. Issue を開いて問題を説明する、または
  2. 修正を加えた Pull Request を提出する

翻訳を追加・改善する

私たちは、自然な読みやすさと技術的な正確さのバランスがとれた翻訳を大切にしています。

翻訳に必要なもの:

  • 自然適応: 適切な文構造に変更し、はじめからその言語で書かれたかのように読めるべきです。不自然に見える場合は、意訳も交えてみましょう。

  • 技術的一貫性: ブラウザー固有の用語 ( "拡張機能", "ワークスペース", "サイドバー" など) は、公式の翻訳が存在するなら、それに従うべきです。新しい用語や未翻訳の用語についても、すべてのドキュメントで一貫性を保ちましょう。

  • 構造一致: 翻訳は、原文となる英語版のページ構成に従うべきです。

貢献の流れ:

  1. 既存の翻訳を確認する (例: docs/en/)
  2. 新しい言語の場合は、正しい ISO 639-1 コードを使用してフォルダーを作成する
  3. Pull Request で変更を提出する
重要

翻訳は積極的に維持されなければなりません。5 ヶ月以上更新や活動がなく、事前の通知もない場合、その言語は削除される可能性があります。

貢献方法

  1. リポジトリをフォークする
  2. 新しいブランチを作成する
  3. 内容を説明するメッセージを添えて変更をコミットする
  4. Pull Request を開く
  5. フィードバックに対応し、必要な修正を加える

Floorp のドキュメントの改善にご協力いただきありがとうございます!