Skip to content

Add CHANGELOG.md #96

Description

@Snailedlt

related to #72

Should contain all the changes between each version, as well as the contributor who did the change.

If it's not too much work it would be nice to automate this too. Maybe we can just grab the version from the main package.json, and show a list of commits.

Examples

I really like these changelogs:

What should the changelog include?

  • Release version with link to release
  • Release date
  • A list of commits containing the following:
    • commit hash with link
    • commit message
    • link to pr

Example

v0.1.0 - August 9th, 2023

Commits

  • 40d568f Minor documentation changes (Minor documentation changes #92)
    • Update urls in root README

    • update /apps/api README with new api url

    • Add .env documentation

    • Add vscode recommendation

    • Edit apps/web readme

    • Add deployment badge for both api and web

v0.2.0 - September 3rd, 2023

...

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Status
    No status

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions