Kubernetesのドキュメントに貢献する

ドキュメントやウェブサイトに貢献したい方、ご協力お待ちしています。 はじめての方、久しぶりの方、開発者でもエンドユーザでも、はたまたタイポを見逃せない方でもどなたでも貢献可能です。

はじめに

どなたでも、問題を説明するissueや、ドキュメントの改善を求めるissueを作成し、プルリクエスト(PR)を用いて変更に貢献することができます。 一部のタスクでは、Kubernetes organizationで、より多くの信頼とアクセス権限が必要です。 役割と権限についての詳細は、SIG Docsへの参加を参照してください。

Kubernetesのドキュメントは、GitHubのリポジトリーにあります。 どなたからの貢献も歓迎しますが、Kubernetesコミュニティの効果的な運用のためには、gitとGitHubを基本的に使いこなせる必要があります。

ドキュメンテーションに関わるには:

1. CNCFのContributor License Agreementにサインしてください。
2. ドキュメンテーションのリポジトリーと、ウェブサイトの静的サイトジェネレーターに慣れ親しんでください。
3. コンテンツの改善と変更レビューの基本的なプロセスを理解していることを確認してください。

貢献するためのベストプラクティス

• 明快で意味のあるGitコミットメッセージを書いてください。
• PRがマージされたときにissueを参照し、自動的にissueをクローズする Github Special Keywords を必ず含めるようにしてください。
• タイプミスの修正や、スタイルの変更、文法の変更などのような小さな変更をPRに加える場合は、比較的小さな変更のためにコミットの数が増えすぎないように、コミットはまとめてください。
• あなたがコードを変更をした理由を示し、レビュアーがあなたのPRを理解するのに十分な情報を確保した適切なPR説明を、必ず含めるようにしてください。
• 追加文献 :
  • chris.beams.io/posts/git-commit/
  • github.com/blog/1506-closing-issues-via-pull-requests
  • davidwalsh.name/squash-commits-git

その他の貢献方法

• TwitterやStack Overflowといったオンラインフォーラムを通してKubernetesコミュニティに貢献したい方、または各地のミートアップやイベントについて知りたい方はKubernetes community siteへ。
• 機能開発に貢献したい方は、まずはじめにKubernetesコントリビューターチートシートを読んでください。

次の項目

• ドキュメントへの貢献の基本について、さらに知りたい場合は、貢献の開始を参照してください。
• 変更を提案をする際は、Kubernetesドキュメンテーションスタイルガイドに従ってください。
• SIG Docsについて、さらに知りたい場合は、SIG Docsへの参加を参照してください。
• Kubernetesドキュメントのローカライズについて、さらに知りたい場合は、Kubernetesドキュメントのローカライズを参照してください。