Escreva um changelog, a partir dos seus commits

Preencha um formulário curto e obtenha um README.md organizado com passos de instalação, uso, configuração e licença ou um CHANGELOG.md no formato Keep a Changelog. Veja o resultado enquanto digita. Tudo é escrito no seu navegador, e nada do que você digita é enviado. É grátis.

Como criar um README, passo a passo

1. Escolha README.md no topo.
2. Em Sobre o projeto, informe o Nome do projeto, um Resumo em uma linha, uma Descrição e os Recursos e Requisitos, um por linha.
3. Em Instalar e usar, escolha um Gerenciador de pacotes como npm, pip ou Cargo, adicione a URL do repositório e escreva o seu Uso. Escolha a linguagem do Uso para o código ser formatado corretamente.
4. Adicione comandos de Configurações e Desenvolvimento se couber.
5. Escolha uma Licença e o Detentor do copyright e ative o Sumário, o selo de Licença ou a seção Como contribuir conforme precisar.
6. Toque em Copiar Markdown ou Baixar README.md.

O que faz um bom README

Diga o que o projeto faz em uma linha e depois mostre como instalá-lo e o menor exemplo que funciona. Os leitores decidem em segundos se um projeto serve, então recursos e requisitos vêm a seguir, seguidos de configurações, comandos de desenvolvimento, como contribuir e a licença. As seções que você deixa vazias ficam de fora.

Changelogs que as pessoas conseguem ler

O changelog segue o Keep a Changelog: a versão mais recente primeiro, cada uma com uma data e as alterações agrupadas em Adicionado, Alterado, Descontinuado, Removido, Corrigido e Segurança. Mantenha uma seção Não lançado no topo para alterações que ainda não foram publicadas. Com o endereço de um repositório, cada versão leva à comparação com a anterior. Você pode adicionar uma versão mais antiga à mão ou criar entradas a partir de mensagens de commit.

Dicas

• Coloque um comando de instalação que funcione e um exemplo curto de uso perto do topo.
• Cite a licença com clareza para os outros saberem como podem usar o seu código.
• Mantenha a descrição sobre o que o projeto faz para o leitor, e não sobre como você o construiu.
• Atualize o changelog a cada versão, e não só no fim.

Para manter segredos e arquivos de build fora de um repositório, use o gerador de .gitignore e o gerador de .env.example.

Perguntas

Posso começar pelo meu histórico de commits?

Sim. Cole a saída de git log --oneline em A partir das mensagens de commit. Commits escritos como feat:, fix:, perf: e assim por diante são organizados nos grupos certos, e mudanças incompatíveis marcadas com ponto de exclamação recebem um rótulo. Ajuste a redação depois; mensagens de commit são escritas para desenvolvedores, e changelogs para usuários.

Ele adiciona o texto da licença?

Ele adiciona uma seção de Licença que cita a licença e aponta para um arquivo LICENSE. Coloque o texto completo da licença nesse arquivo; a página oficial da licença o tem.

Onde ficam os arquivos?

Baixar salva o README.md ou o CHANGELOG.md no seu dispositivo. Coloque-o na raiz do repositório e os serviços de hospedagem de código o exibirão na página do projeto.

Quais licenças posso escolher?

MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, ISC, MPL 2.0, Unlicense ou Todos os direitos reservados, ou deixe a seção de fora.