Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Sugestão] Changelog de alterações #225

Open
chriscorrales opened this issue Aug 4, 2021 · 0 comments
Open

[Sugestão] Changelog de alterações #225

chriscorrales opened this issue Aug 4, 2021 · 0 comments

Comments

@chriscorrales
Copy link

Olá galera!

A minha sugestão é adicionar um arquivo CHANGELOG.md. Esse doc ajuda bastante aos desenvolvedores que usam a biblioteca a olharem quais foram as mudanças como breaking changes, fix, features, etc. Além disso, é possível automatizar a criação desse doc usando a biblioteca standard-version e várias outras, vale destacar que para automatizar é preciso ter commits convencionais e versionamento semantico.

Estou a disposição para ajudar, se vocês aceitarem essa sugestão.

Segue alguns exemplos de CHANGELOG.md:
Eslint CHANGELOG
React CHANGELOG
Sentry CHANGELOG

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant