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

Add CHANGELOG.md #96

Open
Snailedlt opened this issue Aug 9, 2023 · 0 comments
Open

Add CHANGELOG.md #96

Snailedlt opened this issue Aug 9, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation hacktoberfest help wanted Extra attention is needed
Milestone

Comments

@Snailedlt
Copy link
Owner

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

...

@Snailedlt Snailedlt added the help wanted Extra attention is needed label Aug 9, 2023
@Snailedlt Snailedlt added the documentation Improvements or additions to documentation label Aug 9, 2023
@Snailedlt Snailedlt added this to the V1.1 milestone Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

1 participant