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.

Sign up for GitHub

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

Jump to bottom

fix: remove visual underlines on badge links in README.md #1030

Merged
merged 2 commits into from
Nov 14, 2023
Merged

fix: remove visual underlines on badge links in README.md #1030

merged 2 commits into from
Nov 14, 2023

Conversation

5hraddha
Copy link
Contributor

PR Checklist

Overview

This PR removes the visual underlines on badge links in README.md, introduced by the recent GitHub changes (to render the underlines by default). The problem was that the <link> and <img> tags were on separate lines, thus creating unnecessary spaces in between. These spaces were rendering empty links with an underline. 💖

@codecov Codecov
Copy link

codecov bot commented Nov 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (62281d8) 94.15% compared to head (6203b99) 94.15%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1030   +/-   ##
=======================================
  Coverage   94.15%   94.15%           
=======================================
  Files          95       95           
  Lines        5454     5454           
  Branches      436      436           
=======================================
  Hits         5135     5135           
  Misses        318      318           
  Partials        1        1
Flag Coverage Δ
create 70.81% <ø> (ø)
initialize 41.21% <ø> (ø)
migrate 69.89% <ø> (ø)
unit 71.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Nov 14, 2023
View reviewed changes
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks! 💯

I'm bummed to not be able to split them across lines for readability ... but if it comes down to that or removing the underline, removing the underline wins.

@JoshuaKGoldberg JoshuaKGoldberg merged commit e25a47f into JoshuaKGoldberg:main Nov 14, 2023
17 checks passed
@JoshuaKGoldberg
Copy link
Owner

@all-contributors please add @5hraddha for code.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

@allcontributors allcontributors bot mentioned this pull request Nov 14, 2023
Merged
@allcontributors AllContributors
Copy link
Contributor

@JoshuaKGoldberg

I've put up a pull request to add @5hraddha! 🎉

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.43.4 🎉

The release is available on:

Cheers! 📦🚀

JoshuaKGoldberg pushed a commit that referenced this pull request Nov 14, 2023
@allcontributors
docs: add 5hraddha as a contributor for code (#1031)
3d11587 
Adds @5hraddha as a contributor for code.

This was requested by JoshuaKGoldberg [in this
comment](#1030 (comment))

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
@5hraddha
Copy link
Contributor Author

Yeah, it's a little weird in terms of readability. I agree with you, @JoshuaKGoldberg.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Nov 14, 2023
Closed
3 tasks
@JoshuaKGoldberg
Copy link
Owner

...and I just realized I forgot a second component to the fix 🤦 whoops. If you want to get a second contribution @5hraddha #1032 is all yours! 😄

(not a bug, just another place to add this nice new feature)

@5hraddha
Copy link
Contributor Author

No worries. Sure, I could work on that. Thank you!

@5hraddha 5hraddha mentioned this pull request Nov 16, 2023
Merged
3 tasks
JoshuaKGoldberg pushed a commit that referenced this pull request Nov 17, 2023
@5hraddha
feat: port README.md badge underlines fix to templates (#1038)
54e3dee 
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #1032
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

This PR ports README.md badge underlines fix (in #1030) to templates
that generates the badges in README.md files and its associated test. 💖
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

🐛 Bug: README.md badge links have visual underlines
2 participants
@5hraddha @JoshuaKGoldberg