Pular para o conteúdo
Even3

A importância de um bom arquivo README

Trecho de 1 min 37 s de Versionando código com git e GitHub, gravado no evento Semana Nacional de Ciência e Tecnologia - Campi Porto Velho Calama, Vilhena, Guajará -Mirim e Porto Velho Zona Norte.

Assistir à gravação completaNo Even3 Conteúdos · 1 h 44 min

Sobre este trecho

Descubra por que criar uma documentação clara no README é fundamental para atrair colaboradores e apresentar seu projeto no GitHub.

Vai de a da gravação.

O que é dito neste trecho

Tem muita gente que não acha, ah, só um arquivo de texto, não não vai servir de nada para mim. Mas para muita gente que vai ler sobre o teu código, que vai tentar implementar alguma coisa que você tentou implementar, que vai replicar alguma coisa, a primeira coisa que ele olha é o porque é ali que eu vou encontrar eh informações fáceis sobre o projeto, sobre o que que ele faz, sobre como replicar ele, por exemplo. Então, às vezes você tem um uma solução extremamente eficiente, muito aplicada, muito muito bem construída, que resolve muito bem um certo problema, mas que você esquece de colocar o porque você simplesmente eh não quis colocar. E aí eh muitas vezes a a possíveis contribuidores para o seu projeto não se interessam em navegar, em conhecer ele, em acessar ele, só porque não tem a não tem um simples de ler, né? Então, é ele que vai dar a cara inicial do teu projeto. Hoje você vê bibliotecas grandes eh do Google, eh enfim, que você encontra um arquivo na no no repositório deles que é extremamente rico, com muita informação, muitos detalhes sobre o projeto, então por isso que é importante ter um arquivo bem construído, né? Exatamente.

Outros trechos deste conteúdo