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

chore: add changelog that points to releases #3207

Merged
merged 1 commit into from
Mar 2, 2024

Conversation

UziTech
Copy link
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
Copy link

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
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
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
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
8 checks passed
@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