Contribuir para a documentação do MVVMCROSS é uma maneira valiosa de ajudar a melhorar a estrutura e ajudar outros desenvolvedores. Aqui está um guia passo a passo sobre como você pode contribuir:
1. Entenda a estrutura de documentação **
O MVVMcross usa o Jekyll para sua documentação, o que significa que cada página requer um assunto frontal YAML. Isso inclui especificar o layout, o título e a categoria da página. O layout é normalmente definido como "documentação", a menos que você esteja editando uma postagem no blog. As categorias devem ser reutilizadas e nomeadas de forma consistente com as existentes no menu [2].2. Familiarize -se com o Markdown **
A documentação usa a mesma sintaxe de marcação que o GitHub. Você pode se referir à referência de marcação do GitHub para diretrizes de formatação. Isso inclui como adicionar links e imagens relativos às suas páginas de documentação [2].3. Configurando Jekyll localmente **
Para alterações maiores, é benéfico configurar o site MVVMcross Github Pages localmente com Jekyll. Isso permite que você visualize suas alterações antes de enviá -las. Você precisará instalar o Jekyll e seguir as instruções do Github para configurar um site de páginas do Github localmente [2].4. Diretrizes de contribuição **
- Títulos e frases: mantenha -os curtos e concisos. Idealmente, os títulos devem ter três ou quatro palavras.- Ordem cronológica: descreva tópicos em uma sequência lógica.
- Mantenha o tópico: Evite se desviar do assunto principal.
- Gramática e pontuação: Garanta o uso adequado da gramática e da pontuação.
- Ortografia do verificador: use um verificador de ortografia para minimizar erros [2].
5. Envie suas contribuições **
As contribuições geralmente são feitas através de solicitações de puxão do GitHub. Você pode editar páginas existentes ou criar novas. Se você não tiver certeza de como proceder, pode começar sugerindo alterações ou discutindo -as com a equipe por meio de problemas do GitHub ou outros canais de suporte [1] [5].6. Envolva -se com a comunidade **
Além de contribuir com documentação, você também pode ajudar compartilhando suas experiências com o MVVMCROSS, arquivando bugs ou participando de discussões. Esse feedback é inestimável para melhorar a estrutura [1].7. Processo de revisão **
Suas contribuições serão revisadas para garantir que elas se alinhem ao estilo de documentação e padrões de qualidade. Esse processo ajuda a manter a consistência na documentação [2].Seguindo estas etapas, você pode contribuir efetivamente para a documentação MVVMCROSS e ajudar a aprimorar o entendimento e o uso da comunidade da comunidade.
Citações:[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/devell/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/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross