貢献の方法
ようこそ
クラウドネイティブ用語集の貢献ガイドへようこそ。 このプロジェクトに貢献できる方法はいくつかありますが、ここではその詳細を説明します：
CNCF用語集レビュー
この用語集のゴールは、複雑なことで有名なクラウドネイティブの空間をシンプルにすることで、より多くの人に親しんでもらうことです。
クラウドネイティブ用語集のコンテンツはGitHub repo に保存されています。 ここには、用語集に関するissues, pull request (PRs), そしてdiscussions のリストがあります。
誰が貢献できるのか？
このプロジェクトにどのように参加できるかは、クラウドネイティブの専門知識のレベルによって異なります。 複雑な概念を簡略化するには、そのトピックに関する深い知識が必要です。 したがって、新しい用語を寄稿するには、その用語に精通している必要があります。 貢献者は通常、これらの技術にしばらく携わってきたエンジニアや、クラウドネイティブに焦点を当てたアカデミックの経験者です。
複雑な概念を簡単な言葉で説明するのは 本当 に難しいので、そのノウハウが必要です。そして、消化しやすく、ユーザーフレンドリーな結果は簡単に見えるかもしれませんが、望ましいシンプルさを実現するためには、クラウドネイティブの専門家たちの努力と協力が必要です。
もしあなたがまだクラウドネイティブの専門家ではないが、それでも貢献したいのであれば、専門家とチームを組むことをお勧めします。 その専門家が、その用語がコンセプトを正確に表現していると確信したら、最初の用語集への投稿の準備ができました。
翻訳は、他言語に精通した初心者が用語集に貢献できる貴重な場です。 英語での定義がしっかりしていれば、経験の浅い貢献者でも、用語を目標の言語に翻訳することができます。既存の翻訳チームに参加することも、新しいチームを作ることもできます。このガイドの用語集の翻訳を支援するのセクションを読んで、開始方法を学んでください。
始める前に
用語集へ貢献する旅を始める前に、必ず以下のステップを完了してください：
- GitHub アカウントを持っていなければ作成する。
- 貢献者ライセンス契約書 (CLA)にサインする。
- コミット署名を確認する
- GitHubアカウントで警戒モードを有効にすると、コミット時に検証ステータスが表示されます。
ベストプラクティス
レビューを容易にするため、セマンティック改行を使用してください（例：1文につき1行など）。 私たちは、GitHubでマークダウンテキストを正しくフォーマットするために、このマークダウンのチートシートを確認することをお勧めします（例：ハイパーリンク、ボールド、イタリック）。 また、.md ファイルに名前をつけるときは、単語を区切るために小文字とスペースではなくハイフンを使い括弧は避けてください。
スタイルガイド
スタイルガイドを読んで、文書のフォーマットや書き方に関するガイドラインを理解し、投稿プロセスをより効率的にしてください。
用語集コミュニティに参加する！
定期的に貢献したい場合は、毎月開催されるGlossary Working Groupのミーティングに参加することを検討してください。 ミーティングの詳細は、CNCFカレンダーで確認できます。 また、CNCF Slackの#glossaryチャンネルで、メンテナや他の貢献者とつながることもできます。あなたにお会いできるのを楽しみにしています！
既存の課題に取り組む
用語集のGitHub issuesに行くと、利用可能なissueのリストが見つかります。 ラベル（例：English language、help needed、good first issue）を使って、課題をフィルタリングすることができます。
選択した用語がすでに誰かに割り当てられていないことを確認してください。 例えば、ここでは、最初の3つの用語は利用可能ですが、4番目の用語はすでに割り当てられていることがわかります。
取り組むべき用語を選択したら、そのissueに対してコメントする。
さらに、CNCF Slackの#glossaryチャンネルでメンテナに通知してください、そして @Catherine Paganini, @Seokho Son, @Jihoon Seo, および/または @iamnoah をタグ付けして、メンテナが見逃さないようにします。
次のステップについては、新しい用語の提案（PRの作成）(#submitting-a-new-term)のセクションを参照してください。
備考: メンテナがissueをあなたに割り当てた後、そのissueに取り組み始めることができます。 一度に要求できるのは1つの用語のみです。 複数の用語に対する作業は順次行われ、次の用語を要求する前に用語を完了させる必要があります。
新しい用語の提案
新しい用語を提案して他の人に取り組んでもらうことも、自分で新しい定義を作ることもできます。 いずれにせよ、まずはissueの作成から始めることになります。 用語集に追加するには、すべての新しい用語がCNCFのクラウドネイティブ定義を満たしている必要があります。 ただし、クラウドネイティブの概念を理解するために必要な基礎的な用語だけは例外です。
以下は、GitHubに不慣れな人のためのステップバイステップガイドです。 GitHub Proの方は、このガイドに 目を通して 、以下のトピックについて十分な情報を集めてください：
- issueおよび新しい用語のテンプレートを探す
- issueを要求する
- スペルチェックの失敗を解決する
issueを作成する
用語集のGitHub repoissuesにアクセスして"New issue"をクリックしてください。
テンプレート一覧から「Request to add a new term (English)」を選択します。
提案する単語を追加し、質問に答え、チェックボックスにチェックを入れて、「Submit new issue」を押してください。 新しい用語を提案するだけなら、これで完了です！定義に取り組みたい場合は、このまま読み進めてください。
issueの優先順位
次に、メンテナンス担当者はその問題の優先度を決めます。 つまり、その用語が用語集に含まれるべきかどうかを評価するのです。 すべての用語が認められるわけではありません。用語集に含めるには、確立された、広く使われているクラウドネイティブコンセプトである必要があります 。 Slackでメンテナに新しい用語を提案したことを知らせてください。そして @Catherine Paganini, @Seokho Son, @Jihoon Seo, および/また @iamnoah のタグを付けることを忘れないでください。 もし、あなたがその定義に取り組みたいのであればメンテナに知らせてください。メンテナがあなたをアサインします。
新しい用語を登録する（PRを作成する）
スタイルガイドにあるように、GoogleやWordのドキュメントで始めることを強くお勧めします。
用語の提出準備が整ったら、「content」へ…
…次に、「en（英語の場合）」または貢献する言語の最初の2文字..
…そして _TEMPLATE.md を選択します。
内容をコピーする…
…「en」フォルダーに戻ります。「Add file」をクリックし、「Create new file」を選択します。
ベストプラクティスセクションで説明したURLに、用語の名前を追加します。 名前の最後に拡張子.mdを追加します（この拡張子がないとファイルをプレビューすることができません）。 次に、下のセクションにテンプレートの内容を貼り付けます。定義のテキストをコピーして、ファイルに貼り付けてください。 ベストプラクティスのセクションで説明したように、マークダウンを使用したことを確認するために、「Preview」をクリックします。
下にスクロールして、新しいコミットファイルに名前をつけます。提出する準備ができたら、「Commit new file」を押してください。 そして…
…これで新しいPRを作成する準備ができました
「Create pull request」ボタンを押すと、「Pull requests」タブにPRが表示されます。
既存の用語を更新する
既存の用語を更新するには、issueを作成して変更を依頼するか、自分で変更を行ってPRを提出します。
issueから変更を依頼する
用語に関する問題にフラグを立てたい場合は、CNCF用語集ウェブページの「問題を報告する」オプションを使用することができます。 フラグを立てたいコンセプトのCNCFページで自分の位置を確認し、「Report issue」をクリックします。 これにより、自動的にあなたのためのissueが開かれます。
あなたの提案と、それがなぜ必要なのかを説明してください。送信を押してください、それで終わりです。
用語を直接更新する
用語を修正したり、提案を提出したりするには、「Edit this page」をクリックします。
これにより、その用語のGitHubページが開きます。変更を加え、PRを作成してください。 上記のベストプラクティスセクションを参照し、私たちのスタイルガイドを読んで、私たちのガイドラインに従っていることを確認してください。
用語集のローカライズを支援する
用語集を目的の言語にローカライズするのを手伝うには、CNCF Slackワークスペースの #glossary-localizations チャンネルに参加し、私たちにメッセージを送ってください。 既存のチームに参加することも、新しいチームを作ることもできます。 (何が必要かは、ローカリゼーションガイドを読んでください)。 チームの貢献プロセスの詳細を収集するために、目的の言語の How to contribute ガイドをお読みください。
スペルチェック
スペルチェックが失敗する理由は、主に2つあります：
- PRにスペルミスが含まれている。
- PRには、単語リストに登録されていない単語が含まれています。
新しい単語をリストに追加するには、次の手順に従います：
- PRの中に「wordlist.txt」というファイルを見つけます。
- 「このファイルを編集する」をクリックし、不足している単語をアルファベット順に追加します。
- コミットメッセージを追加し、「サインオフして変更を提案する」を選択します。
注意：スペルチェックは大文字と小文字を区別しません。
The Good Docs Projectのテンプレートに基づき、このガイドを更新しました。