为MVVMCross文档做出贡献是帮助改善框架并协助其他开发人员的宝贵方法。这是有关如何贡献的分步指南:
1。了解文档结构**
MVVMCROSS使用Jekyll进行文档,这意味着每个页面都需要YAML的前面问题。这包括指定页面的布局,标题和类别。除非您要编辑博客文章,否则布局通常设置为“文档”。应重复使用类别,并与菜单中现有的类别持续命名[2]。2。熟悉Markdown **
该文档使用与GitHub相同的降价语法。您可以参考GitHub的Markdown参考,以进行格式化指南。这包括如何将相对链接和图像添加到文档页面[2]。3。在本地设置Jekyll **
对于更大的更改,与Jekyll本地建立MVVMCross GitHub页面网站是有益的。这使您可以在提交更改之前预览更改。您需要安装jekyll并按照GitHub的说明进行操作,以在本地设置GitHub页面网站[2]。4。贡献指南**
- 标题和句子:使它们简短而简洁。理想情况下应该是三四个单词。- 时间顺序:用逻辑序列描述主题。
- 保持主题:避免偏离主要主题。
- 语法和标点符号:确保正确使用语法和标点符号。
- 拼写检查器:使用拼写检查器最小化错误[2]。
5。提交您的捐款**
贡献通常是通过github拉的请求做出的。您可以编辑现有页面或创建新页面。如果您不确定如何进行,则可以从建议更改或通过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-usion-app-anp-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/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross