Fix malformed link in CHANGELOG file

[jpl-jengelke]

Purpose

• Update link to be fully formed with proper INSERT tags. ...

Proposed Changes

• Modification to CHANGELOG.md file to present link to release for insertion during infusion.

Issues

• Malformed Link: CHANGELOG.md link to release is malformed #3

Testing

• Reviewed by Git Diff tool

[riverma]

Suggest reverting this based on comments.

[riverma]

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.

[jpl-jengelke]

sorry, I should’ve been clear to point out that the example provided by keepachangelog.com actually links those values back to the repository. So it appears that the example may be malformed, or that they simply did not put the rest of the link there. The bracketed value implies a link format, otherwise I don’t know why the brackets are there. we certainly don’t have to change it, but their example shows links from the bracketed values.

________________________________ From: Rishi Verma ***@***.***> Sent: Friday, September 29, 2023 1:15 PM To: NASA-AMMOS/slim-starterkit ***@***.***> Cc: Engelke, John M (US 398F-Affiliate) ***@***.***>; Mention ***@***.***> Subject: [EXTERNAL] Re: [NASA-AMMOS/slim-starterkit] Fix malformed link in CHANGELOG file (PR #4) @riverma requested changes on this pull request. Suggest reverting this based on comments.

________________________________ In CHANGELOG.md<https://urldefense.us/v3/__https://github.com/NASA-AMMOS/slim-starterkit/pull/4*discussion_r1341758997__;Iw!!PvBDto6Hs4WbVuu7!Pj0XdjbgZvhc3ylqpw5_WaxVlIw3teLAAHJMMTlgVPEX_w03QRihU94sN0WvoNE5vLJZiv3dDPhnuByY-d1GrAsFcGaZWQ$>:

@@ -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 Hi @jpl-jengelke<https://urldefense.us/v3/__https://github.com/jpl-jengelke__;!!PvBDto6Hs4WbVuu7!Pj0XdjbgZvhc3ylqpw5_WaxVlIw3teLAAHJMMTlgVPEX_w03QRihU94sN0WvoNE5vLJZiv3dDPhnuByY-d1GrAsK652bhQ$> - 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/<https://urldefense.us/v3/__https://keepachangelog.com/en/1.0.0/__;!!PvBDto6Hs4WbVuu7!Pj0XdjbgZvhc3ylqpw5_WaxVlIw3teLAAHJMMTlgVPEX_w03QRihU94sN0WvoNE5vLJZiv3dDPhnuByY-d1GrAtHnoRbKw$>, 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. — Reply to this email directly, view it on GitHub<https://urldefense.us/v3/__https://github.com/NASA-AMMOS/slim-starterkit/pull/4*pullrequestreview-1651424115__;Iw!!PvBDto6Hs4WbVuu7!Pj0XdjbgZvhc3ylqpw5_WaxVlIw3teLAAHJMMTlgVPEX_w03QRihU94sN0WvoNE5vLJZiv3dDPhnuByY-d1GrAuVU4kdNw$>, or unsubscribe<https://urldefense.us/v3/__https://github.com/notifications/unsubscribe-auth/AMPAZAF7HHNBCT7GB7ZKZH3X44T6VANCNFSM6AAAAAA5M4RHI4__;!!PvBDto6Hs4WbVuu7!Pj0XdjbgZvhc3ylqpw5_WaxVlIw3teLAAHJMMTlgVPEX_w03QRihU94sN0WvoNE5vLJZiv3dDPhnuByY-d1GrAs-MkVWaQ$>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[riverma]

Hi @jpl-jengelke - were you referring to this example? Links in markdown do start with brackets but must include parenthesis to be interpreted as links, i.e. [X.Y.Z](#linkhere) would imply placing a link, but the below example is just using brackets without implying a link. I suggest we don't modify their template - since it's used widely in industry in the format presented. Appreciate your suggestion to improve though. If you feel strongly, I actually suggest you bring this up with the source project not SLIM. Thank you for thinking deeply about this though!

[jpl-jengelke]

No, actually referring to their linked working example. I will file a bug against the project. The missing parentheses may be an artifact of document publishing, or they may have meant one or the other format. Just seeking clarity. [image/jpeg][image/jpeg]

…

________________________________ From: Rishi Verma ***@***.***> Sent: Friday, September 29, 2023 1:57 PM To: NASA-AMMOS/slim-starterkit ***@***.***> Cc: Engelke, John M (US 398F-Affiliate) ***@***.***>; Mention ***@***.***> Subject: [EXTERNAL] Re: [NASA-AMMOS/slim-starterkit] Fix malformed link in CHANGELOG file (PR #4) Hi @jpl-jengelke<https://urldefense.us/v3/__https://github.com/jpl-jengelke__;!!PvBDto6Hs4WbVuu7!LsVNs-QKuRElh7vev-72O8Cg7hjqDGUIjzlQuB8jEM7Mu9S0ScxEVDZzXatPw0CoipNQ-n4ichCfsMYiXX5N1EAnUzsZCg$> - were you referring to this example? Links in markdown do start with brackets but must include parenthesis to be interpreted as links, i.e. [X.Y.Z](#linkhere) would imply placing a link, but the below example is just using brackets without implying a link. I suggest we don't modify their template - since it's used widely in industry in the format presented. Appreciate your suggestion to improve though. If you feel strongly, I actually suggest you bring this up with the source project<https://urldefense.us/v3/__https://github.com/olivierlacan/keep-a-changelog/__;!!PvBDto6Hs4WbVuu7!LsVNs-QKuRElh7vev-72O8Cg7hjqDGUIjzlQuB8jEM7Mu9S0ScxEVDZzXatPw0CoipNQ-n4ichCfsMYiXX5N1EAGmfrTWw$> not SLIM. [Screenshot 2023-09-29 at 1 51 26 PM]<https://urldefense.us/v3/__https://user-images.githubusercontent.com/3129134/271718228-479475c3-1f94-4ca7-a14b-bbf4ff86a95a.png__;!!PvBDto6Hs4WbVuu7!LsVNs-QKuRElh7vev-72O8Cg7hjqDGUIjzlQuB8jEM7Mu9S0ScxEVDZzXatPw0CoipNQ-n4ichCfsMYiXX5N1EAKEVupLA$> — Reply to this email directly, view it on GitHub<https://urldefense.us/v3/__https://github.com/NASA-AMMOS/slim-starterkit/pull/4*issuecomment-1741479493__;Iw!!PvBDto6Hs4WbVuu7!LsVNs-QKuRElh7vev-72O8Cg7hjqDGUIjzlQuB8jEM7Mu9S0ScxEVDZzXatPw0CoipNQ-n4ichCfsMYiXX5N1EBYfp_zfg$>, or unsubscribe<https://urldefense.us/v3/__https://github.com/notifications/unsubscribe-auth/AMPAZAAWOMQ7PZCPY6T37ATX44Y2DANCNFSM6AAAAAA5M4RHI4__;!!PvBDto6Hs4WbVuu7!LsVNs-QKuRElh7vev-72O8Cg7hjqDGUIjzlQuB8jEM7Mu9S0ScxEVDZzXatPw0CoipNQ-n4ichCfsMYiXX5N1EBEvzEbeQ$>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[riverma]

No, actually referring to their linked working example. I will file a bug against the project. The missing parentheses may be an artifact of document publishing, or they may have meant one or the other format. Just seeking clarity. [image/jpeg][image/jpeg]
…

Thanks @jpl-jengelke! That's a great idea to seek clarity with the public project itself. That being said - just wanted to clarify that our SLIM community projects can seek to customize as they see fit. Our SLIM guide doesn't have a Markdown example we directly host - we directly point to the CHANGELOG project - so that's also one reason it's better to resolve this at the top-level project level.