44. Políticas de contribuição (CONTRIBUTING.md)
Página 44
Políticas de Contribuição (CONTRIBUTING.md)
Quando se trata de projetos de código aberto ou colaborativos, estabelecer uma política de contribuição clara é essencial para garantir a qualidade e a consistência do código. O arquivo CONTRIBUTING.md serve como um guia para contribuidores, delineando as expectativas e os passos necessários para uma contribuição bem-sucedida. Este documento é fundamental para criar um ambiente colaborativo onde todos possam participar de forma eficaz.
Importância das Políticas de Contribuição
As políticas de contribuição são importantes porque ajudam a definir padrões de qualidade, explicam como os contribuidores podem se envolver e especificam os tipos de contribuições que são bem-vindas. Elas também podem incluir informações sobre o processo de revisão de código, as convenções de codificação e os testes necessários antes que uma contribuição seja aceita. Ter essas diretrizes disponíveis ajuda a evitar mal-entendidos e a reduzir o tempo gasto corrigindo contribuições que não seguem os padrões do projeto.
O que Incluir no CONTRIBUTING.md
O arquivo CONTRIBUTING.md deve ser abrangente, mas não excessivamente longo, para que os contribuidores possam compreendê-lo facilmente. Abaixo estão os elementos-chave que devem ser incluídos:
- Introdução: Uma breve descrição do projeto e da importância das contribuições.
- Pré-requisitos: Ferramentas, configurações ou conhecimento que os contribuidores devem ter antes de começar.
- Como Configurar o Ambiente de Desenvolvimento: Passos detalhados para configurar o ambiente de desenvolvimento local.
- Como Contribuir: Instruções passo a passo sobre como fazer uma contribuição, incluindo o processo de forking, clonagem, criação de branches, commits, push e criação de pull requests.
- Padrões de Código: Convenções de codificação, estilos de formatação e outras práticas de codificação que os contribuidores devem seguir.
- Política de Testes: Expectativas em relação aos testes que devem acompanhar o código submetido.
- Revisão de Código: Como o processo de revisão de código é conduzido e o que é esperado dos revisores e contribuintes.
- Tipos de Contribuições: Informações sobre os diferentes tipos de contribuições que são bem-vindas, como correções de bugs, novas funcionalidades, atualizações de documentação, etc.
- Comunicação: Canais de comunicação para discussões, como issues, listas de e-mail, chats, etc.
- Código de Conduta: Uma referência ao código de conduta do projeto e a importância de respeitar todos os contribuidores.
- Reconhecimento de Contribuições: Informações sobre como os contribuidores serão reconhecidos por seu trabalho.
Boas Práticas para Escrever um CONTRIBUTING.md
Ao escrever um CONTRIBUTING.md, é importante manter a clareza e a concisão para que os contribuidores possam seguir facilmente as diretrizes. Aqui estão algumas boas práticas:
- Seja Acolhedor: Encoraje novos contribuidores e mostre apreciação pelas contribuições, independentemente do tamanho.
- Use Linguagem Clara: Evite jargões e explique termos técnicos quando necessário.
- Forneça Exemplos: Inclua exemplos de commits bem-sucedidos, mensagens de commit, testes, etc.
- Mantenha Atualizado: Revise e atualize o CONTRIBUTING.md regularmente para refletir as práticas atuais do projeto.
- Facilite a Contribuição: Simplifique o processo tanto quanto possível e forneça templates para issues e pull requests.
- Seja Específico: Forneça detalhes claros sobre o que fazer e o que não fazer.
Exemplo de Estrutura para CONTRIBUTING.md
# Contribuindo para [Nome do Projeto] ## Introdução Bem-vindo ao [Nome do Projeto]. Estamos felizes por você estar considerando contribuir para o nosso projeto. Cada contribuição ajuda a tornar [Nome do Projeto] ainda melhor. ## Pré-requisitos Antes de começar, certifique-se de ter as seguintes ferramentas instaladas... ## Configurando o Ambiente de Desenvolvimento Siga estes passos para configurar seu ambiente de desenvolvimento... ## Como Contribuir Para contribuir com o projeto, siga estes passos... ## Padrões de Código Nós seguimos certas convenções de codificação que podem ser encontradas aqui... ## Política de Testes Certifique-se de incluir testes para qualquer novo código ou correção de bugs... ## Revisão de Código Saiba mais sobre nosso processo de revisão de código... ## Tipos de Contribuições Estamos procurando contribuições nas seguintes áreas... ## Comunicação Para perguntas e discussões, junte-se a nós em... ## Código de Conduta Nosso projeto segue um código de conduta que pode ser encontrado aqui... ## Reconhecimento de Contribuições Contribuições serão reconhecidas através de...
Ao seguir estas diretrizes e incluir um arquivo CONTRIBUTING.md bem estruturado e informativo em seu projeto, você estabelecerá uma base sólida para uma comunidade de contribuidores engajados e produtivos.
Now answer the exercise about the content:
Qual dos seguintes elementos NÃO é mencionado como um componente que deve ser incluído no arquivo CONTRIBUTING.md?
You are right! Congratulations, now go to the next page
You missed! Try again.
Next page of the Free Ebook: