Versionamento semântico e Changelog
[click here for English]
Todos os projetos deviam ter um versionamento semântico, assim facilitaria o uso de versões específicas como dependências e versões antigas para plataformas específicas ou mesmo evitar aquele bug que surgiu na versão X.Y.Z do projeto.
Versionamento semântico
Conjunto simples de regras e requisitos que determinam como os números da versão são atribuídos e por sua vez, incrementados.
- MAJOR: quando você realizar alterações incompatíveis da API;
- MINOR: quando você adicionar funcionalidades compatíveis com versões anteriores;
- PATCH: quando você corrigir erros compatíveis com versões anteriores.
Você pode ler mais sobre a especificação em:
Changelog
Quando você vai atualizar algum projeto e deseja saber o que mudou, você vai atrás de todas as release anteriores e o changelog é um arquivo que facilita isso para você e seus usuários.
Como fazer um bom changelog?
Princípios fundamentais
- Changelogs são para humanos, não máquinas.
- Deve haver uma entrada para cada versão.
- Alterações do mesmo tipo devem ser agrupadas.
- Versões e seções devem ser vinculadas (com links).
- A versão mais recente vem em primeiro lugar.
- A data de lançamento de cada versão é exibida.
- Mencione se você segue o versionamento semântico.
Tipos de mudanças
Crie suas tags para ajudar a visualizar o changelog, caso precise de ajuda segue alguns padrões:
Você pode ler mais sobre em:
Obrigado por ler!
Se você tiver alguma dúvida, reclamação ou dica, pode deixar aqui nos comentários. Vou ter o maior prazer em responder!
😊😊Até mais! 😊😊
