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

CHANGELOG: Add missing links to Github issues #5809

Merged
merged 1 commit into from Apr 12, 2018

Conversation

straight-shoota
Copy link
Member

@straight-shoota straight-shoota commented Mar 11, 2018

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.

@straight-shoota
Copy link
Member Author

Can this get a second approval? 👍

@luislavena
Copy link
Contributor

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.

@straight-shoota
Copy link
Member Author

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.

@luislavena
Copy link
Contributor

  1. Usage of inline links have been used just in recent versions (0.24 series) and randomly in previous ones.
  2. It introduces a huge diff for previous versions.

What is the final benefit of adding links to really old versions?

@straight-shoota
Copy link
Member Author

  1. Yes, the purpose of this PR is to add the missing links, at least where specific issues are referenced.
  2. Who cares?
  3. 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.

@luislavena
Copy link
Contributor

@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. 👍

@straight-shoota
Copy link
Member Author

@luislavena sorry for the confusion. I thought it was self-explanatory. Added the explanation in the OP.

@sdogruyol sdogruyol merged commit 8ce742a into crystal-lang:master Apr 12, 2018
@straight-shoota straight-shoota deleted the patch-2 branch April 12, 2018 08:35
@RX14 RX14 added this to the Next milestone Apr 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants