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.
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