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.