Modelo de README

Miss√£o

Esta seção deve conter uma breve descrição (3-5 frases) da missão do seu projeto. O objetivo é declarar sobre o que você planeja trabalhar e ajudar os contribuidores externos a entenderem mais ou menos quais tipos de recursos provavelmente serão bem-vindos para este projeto.

Veja também o capítulo de declaração de missão em Producing Open Source Software.

Primeiros Passos

Esta seção deve conter uma breve documentação escrita para usuários iniciantes sobre como começar a usar o projeto. Além disso, documentação mais detalhada pode ser vinculada a partir daqui.

Mais Informa√ß√Ķes

Esta se√ß√£o pode listar qualquer uma ou todas as seguintes informa√ß√Ķes:

  • Uma lista de recursos, casos de uso que o software aborda.

  • Informa√ß√Ķes sobre os princ√≠pios de design que s√£o usados para resolver compensa√ß√Ķes.

  • Links para documenta√ß√£o de n√≠vel de usu√°rio mais detalhada.

  • Respostas √†s perguntas frequentes (FAQ), de prefer√™ncia em um formato que permita vincular a perguntas espec√≠ficas e suas respostas para refer√™ncia mais f√°cil.

Obtendo Ajuda

Esta seção deve conter uma breve documentação sobre como obter ajuda para o projeto como usuário. Isso pode ser tão simples quanto direcionar os usuários para o rastreador de problemas se este for o método que seu projeto deseja usar para responder a perguntas. Também pode apontar para um canal de chat arquivado e pesquisável, alguma lista de discussão arquivada e pesquisável, ou algum fórum online para usuários.

Se envolvendo

Esta se√ß√£o deve incluir informa√ß√Ķes sobre como entrar em contato com o projeto: Tipicamente, isso conter√° links para canais de comunica√ß√£o arquivados, pesquis√°veis e link√°veis.

Quem somos

Este é um bom lugar para dar crédito aos Trusted Committers do projeto.

Tamb√©m √© um bom lugar para incluir informa√ß√Ķes sobre o que significa ser um Trusted Committer para este projeto - embora o ideal seja que todos os projetos em uma organiza√ß√£o usem a mesma defini√ß√£o que √© vinculada apenas a partir daqui. A raz√£o para manter o link aqui √© para que colegas que n√£o t√™m ou t√™m pouca experi√™ncia em trabalhar e contribuir para projetos InnerSource tenham um link direto de volta para informa√ß√Ķes em toda a empresa dos projetos tecnol√≥gicos necess√°rios para seu trabalho di√°rio.

Contribuindo

Esta seção deve documentar (ou vincular à documentação) tudo o que um contribuidor de primeira viagem precisa saber para começar. Normalmente, nem todos os tópicos abaixo serão cobertos. Foque no que difere em seu projeto do setup padrão e no que contribuidores anteriores acharam difícil de entender.

  • Encontrar o c√≥digo-fonte.

  • Encontrar uma lista de problemas para os quais seu projeto precisa de ajuda - esses problemas podem ser t√©cnicos e n√£o t√©cnicos. Geralmente voc√™ manter√° esses problemas em um rastreador de problemas acess√≠vel aos contribuidores.

  • Links para documenta√ß√£o adicional, por exemplo, sobre a arquitetura do projeto, conven√ß√Ķes gerais de codifica√ß√£o, conven√ß√Ķes de teste...

  • Para contribui√ß√Ķes t√©cnicas: Fazer altera√ß√Ķes, construir o projeto e testar suas altera√ß√Ķes.

  • Enviar suas altera√ß√Ķes de volta para o projeto.

Idealmente, voc√™ tamb√©m inclui informa√ß√Ķes sobre como √© o processo preferido para altera√ß√Ķes no projeto: Os contribuidores devem primeiro abrir um problema e enviar uma proposta, ou eles podem enviar altera√ß√Ķes imediatamente? O que √© importante para voc√™ ao revisar as contribui√ß√Ķes?

Al√©m disso, voc√™ deve esbo√ßar quaisquer valores de design que deseja seguir no projeto. Tornar esses valores expl√≠citos frequentemente ajuda a resolver trade-offs mais rapidamente e mais facilmente. Al√©m disso, ajuda a tornar transparentes as altera√ß√Ķes em pressupostos anteriormente impl√≠citos.

Com o tempo, voc√™ notar√° que esta se√ß√£o crescer√° substancialmente. Nesse caso, considere mover as informa√ß√Ķes para arquivos separados, como CONTRIBUTING.md e TESTING.md.

Last updated