Skip to content

Fix malformed link in CHANGELOG file #4

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

Open
jpl-jengelke wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix malformed link in CHANGELOG file #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [X.Y.Z] - 2022-MM-DD
## [X.Y.Z](https://github.com/[INSERT YOUR 'PROJECT/REPO' HERE]/releases/tag/X.Y.X) - 2022-MM-DD
Copy link
Collaborator

@riverma riverma Sep 29, 2023

Choose a reason for hiding this comment

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

Hi @jpl-jengelke - I don't think we should include GitHub repository information in the CHANGELOG. The format suggested is based on https://keepachangelog.com/en/1.0.0/, and you may note in their FAQ they've stated to avoid "...non-portable changelog that can only be displayed to users within the context of GitHub". Suggest we leave the CHANGELOG as is and allow projects to customize as needed.


### Added

Expand Down