Skip to content

chore: add changelog that points to releases#3207

Merged
UziTech merged 1 commit intomarkedjs:masterfrom
UziTech:changelog
Mar 2, 2024
Merged

chore: add changelog that points to releases#3207
UziTech merged 1 commit intomarkedjs:masterfrom
UziTech:changelog

Conversation

@UziTech
Copy link
Copy Markdown
Member

@UziTech UziTech commented Mar 1, 2024

Description

Add changelog that points to the releases.

Many people have mentioned marked not having a changelog because they don't know about the release notes.

Contributor

  • no tests required for this PR.

Committer

In most cases, this should be a different person than the contributor.

@UziTech UziTech added the category: docs Documentation changes label Mar 1, 2024
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marked-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 1, 2024 4:08am

@calculuschild
Copy link
Copy Markdown
Contributor

calculuschild commented Mar 1, 2024

Would it be worth adding a link to the release notes somewhere in the docs webpage as well? I don't know where these people are trying to look for a changelog but maybe there.

Copy link
Copy Markdown
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good - keep the "single source of truth" 👍

@UziTech
Copy link
Copy Markdown
Member Author

UziTech commented Mar 2, 2024

I think CHANGELOG.md is pretty standard way to see the changelog.

@UziTech UziTech merged commit c831f35 into markedjs:master Mar 2, 2024
@UziTech UziTech deleted the changelog branch March 2, 2024 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category: docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants