[Sugestão] Changelog de alterações · Issue #225 · BrasilAPI/cep-promise · GitHub
Skip to content

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

Open

Description

@chriscorrales

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions