hey beginners,
parabéns por fazer o seu caminho para o código aberto. É uma grande comunidade.
é um pouco confuso no início. Como contribuir, onde contribuir, Questões, bugs, PR, PR!
não se preocupe, como você se envolve em código aberto você vai aprender tudo.
mas hoje eu gostaria de dar a vocês todos alguns conselhos que eu nunca recebi quando comecei a minha jornada de código aberto.
comecei a contribuir para o código aberto e a colocar todos os meus pequenos projectos paralelos no GitHub há algum tempo., Naquela altura, não sabia da parte do README. O tempo passou e eu comecei a seguir alguns desenvolvedores do kickass. Sem dúvida que todos eles tinham projetos incríveis, mas a coisa mais comum era, todos os seus projetos tinham README impressionante e foi assim que eu vim a saber sobre a importância de um bom README.pare!! Não estou interessado em ler sobre a sua viagem de código aberto. Diz-me como escrever um bom README.fixe. Então aqui você vai –
Antes de começar a colocar seus projetos incríveis no GitHub, eu quero que você vá e leia sobre o desenvolvimento orientado ao Readme primeiro.,por que haveria de me importar com um README?
Open source community is growing rapidly. Os desenvolvedores lançam novos projetos de código aberto no GitHub todos os dias. Como resultado, está se tornando cada vez mais difícil conseguir que seu próprio projeto se destaque do mar de software de código aberto. No entanto, você pode fazer algumas coisas para aumentar suas chances de pegar a atenção de outro desenvolvedor. Uma técnica eficaz e simples é colocar um arquivo README bonito e útil.
O SEU README deve ser tão bom quanto o seu projecto., Um grande arquivo README ajuda o seu projeto a se destacar do mar de software de código aberto no GitHub.
um README é como a face do seu projecto. É o primeiro arquivo que uma pessoa deve ler ao encontrar uma árvore fonte, e deve ser escrito como uma introdução muito breve e muito básica para o software.
um projecto sem README não é tão útil. Vamos dar uma olhada neste projeto, por exemplo.
Sem README, sem Descrição, sem nada. Não fazes ideia do que este tipo construiu, por mais espectacular que seja.,
agora vamos dar uma olhada neste projeto. O autor mencionou instruções detalhadas e claras sobre o projeto e, portanto, mais fácil para os outros para usá-lo e experimentá-lo.
um README agradável é uma boa maneira de ajudar as pessoas a participar do projeto também. Um projeto com readme agradável e screenshots vai chamar a atenção dos usuários melhor, uma vez que é uma maneira direta de explicar por que este projeto importa, e por que as pessoas devem usar e contribuir para o projeto. Good README também deve incluir detalhes suficientes para ajudar um novo usuário a começar, e.g., como compilar, como instalar e como começar a integrar.
Ok. Chega de conversa. Então mostra-me como escrever um bom README.agora que concorda que o README é importante, eu digo-lhe como escrever um. Não é assim tão difícil. Só precisas de ficar com alguns pontos de bala. Aqui estão alguns dos pontos que você deve ter em mente ao escrever um README.
a Formatação do README?,
Agora que você ensinou a si mesmo como e o que escrever em um README, vamos falar um pouco sobre o estilo de README aka formatação.
formatação é uma parte essencial do README. Você pode aprender sobre como formatar seu README daqui e aqui.
No final, tenha em mente
Você não precisa ir full-bore Leiame Driven Development, você não precisa incluir todos os pontos de bala , você não precisa seguir qualquer processo particular. Mas escrever um bom README vai definitivamente melhorar suas habilidades de documentação que vai fazer você um melhor desenvolvedor.,
Leave a Reply