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

🚀 Feature: Port README.md badge underlines fix to templates #1032

Closed
3 tasks done
JoshuaKGoldberg opened this issue Nov 14, 2023 · 1 comment · Fixed by #1038
Closed
3 tasks done

🚀 Feature: Port README.md badge underlines fix to templates #1032

JoshuaKGoldberg opened this issue Nov 14, 2023 · 1 comment · Fixed by #1038
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

I realized about 30 seconds after merging #1030 that I'd forgotten to note: this repository also includes template files to create a new repo or migrate an existing repo. That templating stuff also needs to receive the fix from #1030. My bad for not saying anything 😄.

https://github.com/JoshuaKGoldberg/create-typescript-app/blob/40ad5cb15a2d1250b3ae86566e7fdd9d2602d6d2/src/steps/writeReadme/generateTopContent.ts is the file that generates the badges in README.md files. It'll need to be updated too (and its associated unit test).

Additional Info

#546 is why tests didn't catch this.

Treating this as a feature rather than a bug because nothing new is broken. It just means this repo has a nice README.md than new generated ones will have.
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Nov 14, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Nov 14, 2023
Merged
3 tasks
@5hraddha 5hraddha mentioned this issue Nov 16, 2023
Merged
3 tasks
JoshuaKGoldberg pushed a commit that referenced this issue 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. 💖
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.45.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: port README.md badge underlines fix to templates 5hraddha/create-typescript-app
1 participant
@JoshuaKGoldberg