BrasilAPI / BrasilAPI/cep-promise
[Sugestão] Changelog de alterações
- Dominant language
- JavaScript
- Stars
- 3k
- Forks
- 317
- PR merge metrics
- No merged PRs in 30d
Description
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](https://github.com/conventional-changelog/standard-version) e várias outras, vale destacar que para automatizar é preciso ter [commits convencionais](https://www.conventionalcommits.org/en/v1.0.0/) e [versionamento semantico](https://semver.org/lang/pt-BR/).
Estou a disposição para ajudar, se vocês aceitarem essa sugestão.
Segue alguns exemplos de CHANGELOG.md:
[Eslint CHANGELOG](https://github.com/eslint/eslint/blob/master/CHANGELOG.md)
[React CHANGELOG](https://github.com/facebook/react/blob/main/CHANGELOG.md)
[Sentry CHANGELOG](https://github.com/getsentry/sentry-javascript/blob/master/CHANGELOG.md)
Contributor guide
Research direction
Start by reviewing the proposed CHANGELOG.md examples from ESLint, React, and Sentry, then inspect the repository's existing release and versioning practices. Done means adding a changelog with a documented structure and deciding whether the suggested standard-version, Conventional Commits, and semantic versioning workflow belongs in scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100