feat: improve how references are displayed #19
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
#1161
by @antfu#1127
#1162
by @antfupreflights
andminify
optionsa60a0e9b
After this PR, the changelog would look like this:
preflights
andminify
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.