digitalinnovationone / dio-lab-open-source

Repositório do lab "Contribuindo em um Projeto Open Source no GitHub" da Digital Innovation One.
https://digitalinnovationone.github.io/dio-lab-open-source/
5.73k stars 42.42k forks source link

[SUGESTÃO] Atualização do arquivo CONTRIBUTING.md #42335

Open Marlon-88 opened 1 month ago

Marlon-88 commented 1 month ago

Sua sugestão está relacionada a um problema? Por favor descreva. Sim, o arquivo CONTRIBUTING.md atual é bastante informativo, mas está um pouco extenso e pode ser difícil para novos contribuidores localizar informações específicas rapidamente. Isso pode desmotivar a contribuição ou causar confusão sobre as etapas necessárias.

Descreva a solução que você gostaria Gostaria de sugerir uma reestruturação do documento para torná-lo mais claro e acessível. Isso pode incluir a criação de uma tabela de conteúdos no início do arquivo, links âncora para seções específicas, e a separação das informações em subseções mais detalhadas. Adicionalmente, simplificar a linguagem em algumas partes pode ajudar a tornar o guia mais acessível para contribuidores de diferentes níveis de experiência.

Descreva as alternativas que você considerou Manter o formato atual: Manter o documento como está é uma opção, mas pode continuar a apresentar desafios de acessibilidade e clareza. Dividir o documento em vários arquivos menores: Essa abordagem pode tornar a navegação mais complexa, exigindo que os usuários abram múltiplos documentos. Usar vídeos ou tutoriais interativos: Poderia ser uma boa adição, mas não substitui a necessidade de documentação escrita clara e acessível.

Contexto adicional A reestruturação e simplificação do guia de contribuição pode não apenas facilitar o processo para novos contribuidores, mas também pode melhorar a eficiência e a clareza para contribuidores experientes. Além disso, manter o documento atualizado e alinhado com as melhores práticas pode fortalecer a comunidade ao redor do projeto.

edemach commented 1 month ago

coloquei uma pasta logo/img para os usuários colocar imagens. o ideal é manter essa pasta community vazia pq sempre ao fazer um git push gera uma pr que fica dando erro informando as modificações.