MVVMCrossドキュメントに貢献することは、フレームワークの改善と他の開発者を支援するための貴重な方法です。貢献方法に関する段階的なガイドを次に示します。
1。ドキュメント構造を理解する**
MVVMCrossはドキュメントにJekyllを使用しています。つまり、各ページにはYAMLフロントマターが必要です。これには、ページのレイアウト、タイトル、およびカテゴリの指定が含まれます。レイアウトは通常、ブログ投稿を編集しない限り「ドキュメント」に設定されます。カテゴリは、メニュー[2]の既存のものと一貫して再利用し、名前が付けられている必要があります。2。マークダウンに慣れる**
ドキュメントでは、GitHubと同じMarkdown構文を使用しています。フォーマットガイドラインについては、GitHubのMarkdownリファレンスを参照できます。これには、ドキュメントページ[2]に相対的なリンクと画像を追加する方法が含まれます。3。jekyllをローカルにセットアップ**
より大きな変更については、JekyllでMVVMCross GitHubページサイトをローカルにセットアップすることが有益です。これにより、変更を送信する前にプレビューできます。 Jekyllをインストールし、GithubページサイトをローカルにセットアップするためのGithubの指示に従う必要があります[2]。4。寄付ガイドライン**
- タイトルと文章：短く簡潔にしてください。タイトルは理想的には3つまたは4語の長さでなければなりません。- 年代順の順序：論理シーケンスでトピックを説明します。
- トピックにとどまる：主な主題からの迷子を避けてください。
- 文法と句読点：文法と句読点の適切な使用を確認します。
- スペルチェッカー：スペルチェッカーを使用してエラーを最小限に抑えます[2]。
5。貢献を送信**
通常、寄付はGitHub Pullリクエストを通じて行われます。既存のページを編集したり、新しいページを作成したりできます。どのように進むかがわからない場合は、変更を提案したり、GitHubの問題やその他のサポートチャネルを介してチームと話し合うことから始めることができます[1] [5]。6。コミュニティと交戦**
ドキュメントの貢献に加えて、MVVMCrossとの経験を共有したり、バグを提出したり、ディスカッションに参加したりすることもできます。このフィードバックは、フレームワークを改善するために非常に貴重です[1]。7。レビュープロセス**
貢献は、ドキュメントスタイルと品質基準と一致するようにレビューされます。このプロセスは、ドキュメント全体で一貫性を維持するのに役立ちます[2]。これらの手順に従うことにより、MVVMCrossのドキュメントに効果的に貢献し、コミュニティのフレームワークの理解と使用を強化するのに役立ちます。
引用：[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-app-and-setup
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
[7] https://www.mvvmcross.com/documentation/getting-started/mvvmcross-Overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundmentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross