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

feat: improve how references are displayed #19

Merged
merged 1 commit into from
Jun 30, 2022

Conversation

innocenzi
Copy link
Sponsor Contributor

This PR improves the way references are displayed. It depends on #18.

Before this PR, references are inserted into backticks to display them as code snippets, and they are separated by a single space.

After this PR, references related to an issue or PR are displayed in a list (with commas and a final "and" word when necessary) and prefixed by "in", and references to a specific commit are displayed in parenthesis.

Three examples of the current behavior is:

  • Support for multiple @ parents (@​media, @​supports, etc) #​1161 by @​antfu
  • Revert variant apply order in #​1127 #​1162 by @​antfu
  • New preflights and minify options a60a0e9b

After this PR, the changelog would look like this:

  • Support for multiple @ parents (@​media, @​supports, etc) by @​antfu in #​1161
  • Revert variant apply order by @​antfu in #​1127 and #​1162
  • New preflights and minify options (a60a0e9b)

This design feels cleaner to me (the 'code snippet' references were attracting too much attention), it's inspired by the way the GitHub-generated release changelog is formatted.

@antfu
Copy link
Owner

antfu commented Jun 30, 2022

You might need to resolve the conflicts, thanks.

@innocenzi
Copy link
Sponsor Contributor Author

@antfu done!

@antfu antfu merged commit cdf8fe5 into antfu:main Jun 30, 2022
@innocenzi innocenzi deleted the fix/references branch June 30, 2022 13:29
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.

None yet

2 participants