https://github.com/leoviana00/config-repo-base-autochangelog

Autochangelog através de action e shellscript.
https://github.com/leoviana00/config-repo-base-autochangelog

actions changelog git shell-script

Last synced: 28 days ago
JSON representation

Autochangelog através de action e shellscript.

• Host: GitHub
• URL: https://github.com/leoviana00/config-repo-base-autochangelog
• Owner: leoviana00
• Created: 2024-10-06T15:05:07.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-10-16T11:39:24.000Z (about 1 month ago)
• Last Synced: 2024-10-18T05:32:14.897Z (about 1 month ago)
• Topics: actions, changelog, git, shell-script
• Homepage:
• Size: 354 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
## Autochangelog

Tópicos levados em consideração:

```

- Commits semânticos

- Template personalizado para PR

- Versionamento semântico

- Changelog

- Automação para gerar entradas de changelog a cada commit realizado

```

## Commits Semânticos

Em relação aos commits semânticos, será seguido a convenção de commits.

[Link Documentação](link)

> Importante lembrar:

- Crie commits objetivos:

Os commits descrevem o que foi realizado na alteração que você criou. Por isso, é fundamental descrevê-los com informações relevantes. Criar comentários como “correção de bug” e “nova funcionalidade”, sem maiores detalhes, não ajudará outras pessoas a compreenderem o que foi feito.

- Crie branchs com nomes claros

Garanta que a ramificação que você criou possui um nome significativo. Assim, em projetos muito grandes e com várias pessoas atuando, será mais fácil encontrar o que você modificou e rapidamente entender qual parte do código foi alterada.

- Mantenha a branch principal atualizada

É a partir da ramificação principal que vamos criar outras aos quais iremos realizar nossas alterações. Por isso, é necessário mantê-la sempre atualizada. Assim, teremos a versão mais recente do código e evitaremos conflitos com alterações existentes, mas às quais não estavam presentes no código de trabalho.

- Faça revisão de código

Um potente recurso disponível em diversas ferramentas de versionamento de código é o Code Review (Revisão de Código). Nesse caso, você poderá acionar uma outra pessoa autorizada a acessar o projeto para revisar as suas alterações e garantir que as mudanças poderão ser incorporadas ao código principal. Isso reduz o número de bugs e de código despadronizado. 

## Template personalizado para PR

Para garantir um padrão de informação no PR será criado um template com algumas informas necessárias que ainda serão definidas.

Proposta de template:

```md

## Descrição

## Tipo de mudança

- [ ] Correção de bug (alteração ininterrupta que corrige um problema)

- [ ] Novo recurso (alteração ininterrupta que adiciona funcionalidade)

- [ ] Alteração na documentação

- [ ] Outro (especifique)

## Pre-merge Checklist

- [ ] Meus commits estão de acordo com a padronização de commits e branchs estabelecidos. [Gitflow]

- [ ] Realizei uma auto-revisão do meu código

- [ ] Comentei meu código, principalmente em áreas difíceis de entender

## Emitir número e link do ticket

- [ ] Não possui relação com Issues 

- [ ] Pull Request será vinculado a uma issue usando palavra chave [Pull request vinculado a uma issue]

## Screenshots

| Before | After |

| ------ | ----- |

| N/A  | N/A |