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: port README.md badge underlines fix to templates #1038

Merged

Conversation

5hraddha
Copy link
Contributor

PR Checklist

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. 💖

@5hraddha 5hraddha marked this pull request as draft November 16, 2023 16:38
@5hraddha 5hraddha changed the title feature: port README.md badge underlines fix to templates feat: port README.md badge underlines fix to templates Nov 16, 2023
Copy link

codecov bot commented Nov 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (020b38a) 94.15% compared to head (7e58d17) 94.14%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1038      +/-   ##
==========================================
- Coverage   94.15%   94.14%   -0.02%     
==========================================
  Files          95       95              
  Lines        5454     5444      -10     
  Branches      436      436              
==========================================
- Hits         5135     5125      -10     
  Misses        318      318              
  Partials        1        1              
Flag Coverage Δ
create 70.75% <100.00%> (-0.06%) ⬇️
initialize 41.29% <0.00%> (+0.07%) ⬆️
migrate 69.83% <100.00%> (-0.06%) ⬇️
unit 71.54% <90.00%> (-0.06%) ⬇️

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.

@5hraddha 5hraddha marked this pull request as ready for review November 16, 2023 18:17
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.

A great start! One bug around the repo's template mismatching the .all-contributorsrc badge template, but this is the right direction. Thanks! 🚀

src/steps/writeReadme/generateTopContent.ts Outdated Show resolved Hide resolved
@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author Needs an action taken by the original poster label Nov 16, 2023
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.

This looks great, thanks @5hraddha!

There are some existing inconsistencies in the README.md that make me not super motivated to try to get it all exactly the same. If anybody finds them irksome they can always file an issue. But this PR more than adequately solves for the case of the badge underlines in the template.

Jane Lynch saying 'outstanding'

@JoshuaKGoldberg JoshuaKGoldberg merged commit 54e3dee into JoshuaKGoldberg:main Nov 17, 2023
16 checks passed
Copy link

🎉 This is included in version v1.45.0 🎉

The release is available on:

Cheers! 📦🚀

@5hraddha
Copy link
Contributor Author

Thank you! @JoshuaKGoldberg . If there is anything specific you want to resolve from the existing inconsistencies, please feel free to let me know. I can meddle with it sometime after the weekend. Have a great day!

@JoshuaKGoldberg
Copy link
Owner

You got it! There were really two things I was thinking of:

  1. A couple of the README.md lines were using spaces instead of tabs, I just fixed them in e3eef39 (pushing directly to main)
  2. 🛠 Tooling: Lack of indentation in generated README.md all-contributors badge #1041

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for author Needs an action taken by the original poster
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚀 Feature: Port README.md badge underlines fix to templates
2 participants