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

Links to issues in CHANGELOG.md #1815

Closed
wants to merge 3 commits into from

Conversation

Lette
Copy link
Contributor

@Lette Lette commented Nov 1, 2021

Checklist

  • I have included examples or tests
  • I have updated the change log
  • I am listed in the CONTRIBUTORS file
  • I have cleaned up the commit history (use rebase and squash)

Changes proposed in this pull request:

  • De-linted README.md and CHANGELOG.md, using provided markdownlint configuration.
  • All references to issues in the CHANGELOG are now links to the respective issues.

If you think it's good, keep it. If not, no argument from me.
Thank you for this awesome library!

@oxyplot/admins

@VisualMelon
Copy link
Contributor

Links are certainly nice!

In-line links might be preferable to keep changes simple.

In any case, I won't merge this myself, but I certainly don't object to the changes.

@Lette
Copy link
Contributor Author

Lette commented Nov 1, 2021

I considered inline links but went the other way because the same issues are referenced in multiple places...

I can easily change to inline if you want to.

@VisualMelon
Copy link
Contributor

What does the markdown lint file achieve?

On reflection, I think separating the links out would be better; it'll be a little more effort for contributors and maintainers, but it'll keep the content uncluttered.

I'm not sure how this will work when it is merged, so I'll hang-fire on that for the moment (but otherwise approved).

@Jonarw
Copy link
Member

Jonarw commented Jul 12, 2023

This PR came up in the discussion in #2012. Initially the links seemed like a nice idea to me. However, after thinking a bit more about it, I am not so sure anymore whether the comfort of these links outweighs the added maintenance effort. I don't have a strong opinion either way, probably leaning a bit against it. From what I understand from #2012, you were also a bit skeptical of this @VisualMelon?

@VisualMelon
Copy link
Contributor

VisualMelon commented Jul 12, 2023

@Jonarw From memory I thought I was more opposed to this than it seems I actually was, or indeed am now that I've looked at this properly again. Like you, I'm happy either way, but would probably lean towards leaving things as-is so this isn't another thing that contributors have to worry about.

@Jonarw
Copy link
Member

Jonarw commented Jul 14, 2023

Yes, agreed, so I will close this for now. Thanks anyway @Lette!

@Jonarw Jonarw closed this Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants