Skip to content

docs: explain what is included in the changelog file #561

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Nov 5, 2024
Merged

docs: explain what is included in the changelog file #561

merged 2 commits into from
Nov 5, 2024

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Nov 5, 2024 •
edited
Loading

Documentation updates:

  • Added a description of the purpose of the CHANGELOG.md file and linked to the maxGraph GitHub repository and the semantic versioning page.
  • Included a note about unreleased breaking changes and a link to the GitHub release page for more details on the contents of a release.

@tbouffard tbouffard added the documentation Improvements or additions to documentation label Nov 5, 2024
@tbouffard tbouffard marked this pull request as ready for review November 5, 2024 04:29
@tbouffard tbouffard merged commit 946c09b into main Nov 5, 2024
@tbouffard tbouffard deleted the docs/changelog_file_purpose branch November 5, 2024 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard