Guia para Colaboradores do Mchain Docs

Bem-vindo à comunidade do Mchain Docs! Estamos extremamente gratos pelo seu interesse em melhorar nossa documentação. Aqui está um guia rápido sobre como você pode contribuir de maneira eficaz.

Visão Geral

Para garantir consistência e qualidade em nossa documentação:

1. Começando: Familiarize-se antes de contribuir.
2. Formas de Contribuir: Entenda os diferentes métodos para oferecer sua expertise.
3. Ideias para Contribuir: Obtenha clareza sobre quais contribuições podem ser mais impactantes.

Começando

Antes de mergulhar:

• Identifique problemas indo até a seção de Issues e fornecendo detalhes completos.
• Busque ajuda técnica ou esclarecimentos na plataforma designada, se necessário.
• Se planeja contribuir diretamente para o repositório, sua contribuição pode incluir:
  • Corrigir ortografia ou gramática.
  • Refinar a formatação do código.
  • Consertar links quebrados.

Todas as contribuições devem ser feitas através de uma solicitação de pull (pull request). Cada solicitação deve abordar um único tópico ou correção.

Se você não está familiarizado com o GitHub ou com a criação de solicitações de pull, há vários guias para iniciantes disponíveis no GitHub para ajudá-lo.

Formas de Contribuir

O repositório mestre contém a documentação principal para o portal docs.mchain.network, voltado principalmente para os desenvolvedores do Mchain.

Pequenas Correções

Para ajustes menores, como edições de texto:

1. Clique em "Editar esta página".
2. Faça as correções diretamente no GitHub.
3. Descreva brevemente suas mudanças na mensagem de commit e faça o commit.
4. Escolha "Criar um novo branch para este commit e iniciar um pull request".

Branching e Pull Requests

Para atualizações significativas:

1. Visite o repositório público mchain-docs.
2. Faça um fork ou clone o repositório localmente.
3. Crie um novo branch usando um comando semelhante a:

   git switch -c suas-iniciais/nome-do-branch

Siga os passos subsequentes semelhantes ao exemplo fornecido para finalizar suas atualizações. Depois, inicie um pull request para revisão.

Ideias para Contribuir

Contribuições valiosas frequentemente vêm na forma de guias detalhados ou tutoriais para apoiar outros desenvolvedores.

Se você está considerando uma contribuição, aqui está uma distinção entre um "guia detalhado" e um "tutorial":

Guias Detalhados

Estes fornecem instruções claras para alcançar objetivos específicos. Eles enfatizam passos essenciais e excluem informações não relacionadas.

Tutoriais

Os tutoriais são lições completas passo a passo para leitores novos no assunto. Eles guiam o leitor do início ao fim em uma tarefa específica.

Suas perspectivas irão melhorar significativamente o Mchain Docs. Aguardamos sua contribuição. Celebre cada contribuição bem-sucedida! 🚀