MVVMCrossのGitHub問題をフォーマットする場合、ベストプラクティスに従うことで、明確さ、効率、およびコラボレーションを強化できます。ここにいくつかの詳細なガイドラインがあります:
1。説明タイトル**
命令的なムードを使用し、タイトルが問題の目的を伝えるのに十分な説明であることを確認してください。期間のあるタイトルの終了は避けてください。たとえば、「データバインディングのバグの修正」は、「データバインディングのバグ」または「データ結合バグ」よりも効果的です。[4] [7]。2。クリアの概要**
2行以内の問題の簡潔な概要を提供します。これには、対処されている主な目的または問題が含まれる必要があります。たとえば、「この問題は、Androidデバイスでアプリがクラッシュする原因となるデータバインディングエラーを解決することを目的としています。」[1] [4]。3。依存関係(該当する場合)**
問題が最初に解決される別の問題に依存している場合、その問題へのリンク。これにより、明確なワークフローを維持し、従属タスクが正しい順序で対処されることを保証します。たとえば、「この問題は[依存問題へのリンク]に依存します。」[1]。4。アクションアイテム**
クリック可能なチェックリストとしてアクションアイテムをフォーマットします。これにより、進行状況を簡単に追跡し、チームメンバーにタスクを割り当てることができます。例えば:- []データバインディングエラーの原因を調査します。
- []特定された問題の修正を実装します。
- []複数のプラットフォームで修正をテストします。[1] [4]。
5。リソース/指示**
問題の解決に役立つ関連文書またはリソースへのリンクを含めます。これには、チュートリアル、APIドキュメント、または問題に関連する以前の議論が含まれる場合があります。たとえば、「MVVMCrossドキュメントを参照してください。データバインディングに関するガイダンス。」[1] [2]。6。譲受人**
問題を特定のチームメンバーに割り当てます。これにより、誰がタスクに責任があるかについて説明責任と明確さが保証されます。 GitHubの「譲受人」機能を使用して、ユーザーを割り当てます。[1]。7。ラベル**
関連ラベルを適用して、問題を分類します。これは、プロジェクト内の問題のフィルタリングと優先順位付けに役立ちます。たとえば、ラベルには「バグ」、「機能」、または「強化」が含まれる場合があります。[1] [2]。8。プロジェクトボード**
問題がプロジェクトボードに追加され、適切にトリアージされていることを確認してください。これには、準備ができていない場合は「アイスボックス」に問題のステータスを設定し、「バックログ」が準備ができているが割り当てられていない場合は、割り当てられたら「進行中」に設定します。[1]。###9。マイルストーン**
マイルストーンを使用して、問題のグループの進捗状況を追跡するか、リクエストをプルします。これは、大規模なプロジェクトや複数の関連するタスクを追跡する場合に特に役立ちます。[1]。
###10。ドキュメントと進行状況の更新**
問題のコメントを定期的に進捗状況または変更で更新します。これにより、すべての利害関係者が通知され、共同の問題解決を促進します。[7]。
###順調な問題の例
**タイトル:Androidデバイスのデータバインディングエラーを修正します
**概要:この問題は、Androidデバイスでアプリのクラッシュを引き起こすデータバインディングエラーに対処します。
**依存関係:[依存問題へのリンク]に依存します。
アクションアイテム:
- []データバインディングエラーの原因を調査します。
- []調査結果に基づいて修正を実装します。
- []プラットフォーム間で徹底的なテストを実施します。
**リソース/指示:データバインディングガイダンスについては、mvvmcrossドキュメントを参照してください。
**譲受人:@username
**ラベル:バグ、Android
これらのガイドラインに従うことにより、MVVMCrossプロジェクト内のコラボレーションと効率を高めるための適切に構造化されたGitHubの問題を作成できます。
引用:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-nformation-with-tables
[4] https://tilburgsciencehub.com/topics/automation/version-contol/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practics-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md