在为MVVMCROSS格式化GITHUB问题时,遵循最佳实践可以提高清晰度,效率和协作。以下是一些详细的准则:
1。描述性标题**
使用命令性的心情,并确保标题足以传达问题的目的。避免结束标题。例如,“数据绑定中的修复错误”比“数据绑定中的错误”或“数据绑定错误”更有效。[4] [7]。2。清除概述**
提供两行或更短的简洁概述。这应该包括要解决的主要目标或问题。例如,“此问题旨在解决导致应用程序崩溃的数据绑定错误。” [1] [4]。3。依赖项(如果适用)**
如果问题取决于首先解决另一个问题,请链接到该问题。这有助于保持清晰的工作流程,并确保按正确的顺序解决依赖任务。例如,“此问题取决于[链接到依赖问题]。” [1]。4。动作项目**
格式操作项目作为可单击的清单。这使跟踪进度并将任务分配给团队成员变得容易。例如:- []研究数据结合误差的原因。
- []为已确定的问题实施修复程序。
- []测试多个平台上的修复。[1] [4]。
5。资源/说明**
包括指向可以帮助解决问题的相关文档或资源的链接。这可能包括教程,API文档或与该问题有关的先前讨论。例如,“请参阅MVVMCROSS文档以获取数据绑定指南。” [1] [2]。6。受让人**
将问题分配给特定的团队成员。这样可以确保对谁负责该任务的问责制和清晰度。使用GitHub中的“受让人”功能分配用户。[1]。7。标签**
应用相关标签以对问题进行分类。这有助于过滤和确定项目中的问题。例如,标签可能包括“错误”,“功能”或“增强”。[1] [2]。8。项目委员会**
确保将问题添加到项目委员会中并适当分类。这涉及将问题状态设置为“ ICE框”,如果该状态还没有准备就绪,请确定“积压”,如果准备就绪但未分配,并且一旦分配了“正在进行的”。[1]。9。里程碑**
使用里程碑跟踪问题组或拉的请求的进度。这对于大型项目或跟踪多个相关任务时特别有用。[1]。10。文档和进度更新**
定期使用进度或更改更新问题评论。这使所有利益相关者都知道并促进协作解决问题。[7]。###一个格式良好的示例
**标题:修复Android设备上的数据绑定错误
**概述:此问题解决了导致应用程序崩溃的数据绑定错误。
**依赖性:取决于[链接到依赖性问题]。
动作项目:
- []研究数据绑定误差的原因。
- []根据发现实现修复程序。
- []跨平台进行彻底测试。
**资源/说明:有关数据绑定指南,请参阅MVVMCROSS文档。
**受让人:@username
**标签:错误,Android
通过遵循这些准则,您可以创建结构良好的GITHUB问题,以提高MVVMCross项目中的协作和效率。
引用:[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/organisizing-information-information-with-tables
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-smples
[6] https://github.com/mvvmcross/mvvmcross-smamples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md