ドキュメントへの貢献方法

ドキュメントへの貢献は、他の人がフレームワークを理解するのを助けるため、最も有益な活動の1つです。

書き方

ドキュメントは主に、トピックに慣れていない人々を対象としています。したがって、いくつかの重要な点を満たす必要があります：

• 簡単で一般的なことから始めます。より高度なトピックには最後に進みます
• 物事をできるだけよく説明するように努めます。たとえば、まず同僚にトピックを説明してみてください
• ユーザーが特定のトピックについて実際に知る必要がある情報のみを提供します
• あなたの情報が本当に真実であることを確認します。すべてのコードをテストします
• 簡潔に – 書いたものを半分に短縮します。そして、必要であればもう一度
• 太字から .[note] のようなボックスまで、あらゆる種類の強調表示を控えめに使用します
• コードでは コーディング規約 を遵守します

また、構文 を習得してください。執筆中に記事をプレビューするには、プレビュー付きエディタ を使用できます。

言語バージョン

主要言語は英語です。したがって、あなたの変更はチェコ語と英語の両方であるべきです。英語が得意でない場合は、DeepL Translator を使用し、他の人がテキストをチェックします。

他の言語への翻訳は、あなたの修正が承認され、微調整された後に自動的に行われます。

簡単な編集

ドキュメントに貢献するには、GitHub アカウントが必要です。

ドキュメントに小さな変更を加える最も簡単な方法は、各ページの最後にあるリンクを利用することです：

• GitHubで表示 は、GitHub上の特定のページのソース形式を開きます。その後、E ボタンを押すだけで編集を開始できます（GitHubにログインしている必要があります）
• プレビューを開く はエディタを開き、最終的な視覚的な外観もすぐに確認できます

プレビュー付きエディタ には変更を直接GitHubに保存するオプションがないため、編集が完了したら、ソーステキストをクリップボードにコピーし（クリップボードにコピー ボタンを使用）、それをGitHubのエディタに貼り付ける必要があります。編集フィールドの下には送信フォームがあります。ここで、修正の理由を簡単に要約して説明することを忘れないでください。送信後、いわゆるプルリクエスト（PR）が作成され、さらに編集できます。

より大きな編集

GitHubインターフェースを利用するよりも、Gitバージョン管理システムの基本に精通している方が適しています。Gitの操作に慣れていない場合は、git – the simple guide ガイドを参照したり、多くの グラフィカルクライアント のいずれかを利用したりできます。

ドキュメントを次のように編集します：

1. GitHubで、nette/docs リポジトリの フォーク を作成します
2. このリポジトリを自分のコンピュータに クローン します
3. 次に、関連するブランチ で変更を行います
4. Code-Checker ツールを使用して、テキスト内の余分なスペースをチェックします
5. 変更を保存（コミット）します
6. 変更に満足したら、GitHubの自分のフォークに送信（プッシュ）します
7. そこから、プルリクエスト (PR) を作成して nette/docs リポジトリに送信します

コメントで指摘を受けることは一般的です。提案された変更を追跡し、反映します。提案された変更を新しいコミットとして追加し、再度GitHubに送信します。プルリクエストの修正のために新しいプルリクエストを作成しないでください。

ドキュメントの構造

ドキュメント全体は、GitHubの nette/docs リポジトリにあります。現在のバージョンはマスターにあり、古いバージョンは doc-3.x、doc-2.x のようなブランチにあります。

各ブランチの内容は、ドキュメントの個々の領域を表す主要なフォルダに分割されます。たとえば、application/ は https://doc.nette.org/cs/application に対応し、latte/ は https://latte.nette.org に対応します。これらの各フォルダには、言語バージョン（cs、en、…）を表すサブフォルダと、オプションでドキュメントページに挿入できる画像を含む files サブフォルダが含まれています。