-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
CHANGELOG: Add missing links to Github issues #5809
Conversation
Can this get a second approval? 👍 |
What about using footer links instead? * Something ([#123])
[#123]: https://github.com/crystal-lang/crystal/issues/123 It does not require to change the entire changelog and also doesn't necessarily need to have all the links at the footer of the document, could be between releases and it will not show on the rendered markdown. Cheers. |
What's the benefit? It still needs changes everywhere a link to an issue is referenced. And then again in the footer links section. I don't think there is any downside of having inline links. That's what's been used in the CHANGELOG in other places. Changing that would be out of scope. |
What is the final benefit of adding links to really old versions? |
|
@straight-shoota I care, introducing a diff for the purpose of satisfy the rendered version of a document is a good one, which could have been explained in the first place by simply providing an initial description of the purpose. Please don't get me wrong, I'm not against it, but explaining the real intention behind it not just for the sake of adding links clears these doubts. Thank you for taking the time explaining the reasoning. 👍 |
@luislavena sorry for the confusion. I thought it was self-explanatory. Added the explanation in the OP. |
EDIT:
Sometimes people (at least me and occasionally somebody in chat) want to look up more details about a change even if it was introduced some time ago. Providing the ID of an issue/PR helps finding the relevant discussion. Turning that ID into a hyperlink makes it even easier accessible. This change is simple enough but can help to improve discoverability of previous decision making.