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

🛠 Tooling: Repository uses the wrong emoji in .all-contributorsrc #1086

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 11, 2023 · 2 comments · Fixed by #1140
Closed
3 tasks done

🛠 Tooling: Repository uses the wrong emoji in .all-contributorsrc #1086

JoshuaKGoldberg opened this issue Dec 11, 2023 · 2 comments · Fixed by #1140
Assignees
@JoshuaKGoldberg
Labels
area: tooling Managing the repository's maintenance good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this!

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Dec 11, 2023 •
edited
Loading

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

Thanks to #1048, we see now that this repository has two bits of tooling that are different between its 🍎 actual files and 🍌 code templates (see Additional Info below for explanation of the emojis):

  • 🍎 Actual files: uses 🤝:

    create-typescript-app/.all-contributorsrc

    Line 2 in d66379b

    "badgeTemplate": "<a href=\"#contributors\" target=\"_blank\"><img alt=\"All Contributors: <%= contributors.length %> 🤝\" src=\"https://img.shields.io/badge/all_contributors-<%= contributors.length %>_🤝-21bb42.svg\" /></a>",
  • 🍌 Code templates: uses 👪:

    create-typescript-app/src/steps/writing/creation/writeAllContributorsRC.ts

    Line 12 in d66379b

    ' <a href="#contributors" target="_blank"><img alt="All Contributors: <%= contributors.length %> 👪" src="https://img.shields.io/badge/all_contributors-<%= contributors.length %>_👪-21bb42.svg" /></a>',

The 🍎 .all-contributorsrc file should be updated to use 👪 instead of 🤝. I'd started using 👪 as the emoji for the 🍌 template back in #930 but forgot to update the 🍎 .all-contributorsrc file too.

Marking as a good first issue because there shouldn't be any work here besides changing the emoji in the 🍎 .all-contributorsrc and README.md files.

Additional Info

This repository is two things:

  • 🍎 An example of a working TypeScript repository, including all-contributors, builds, package publishing, and more tooling
  • 🍌 Code that can set up a new or existing repository using all of that repository tooling

For the most part, the repository's end-to-end test for --mode migration makes sure that the 🍎 actual files and 🍌 code templates stay the same. As in, if one changes, the other needs to have the same change as well. But per #546, there are some files that were missed in that test. We're only now able to verify that they're the same as of #1048. That PR is where this discrepancy was discovered.
@JoshuaKGoldberg JoshuaKGoldberg added good first issue Good for newcomers, please hop on! area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! labels Dec 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 11, 2023
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 30, 2023
@JoshuaKGoldberg
Copy link
Owner Author

Assigning to myself so I can test out the migration test improvements added in #1048.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 30, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Dec 30, 2023
@JoshuaKGoldberg
chore: match .all-contributorsrc to template (#1140)
b0f43d7 
## PR Checklist

- [x] Addresses an existing open issue: fixes #1086
- [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

Corrects the emojis and indentation in the `badgeTemplate` property.

Also sets `commitType` manually per #1090 - leaving the issue open.
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.50.2 🎉

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

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: tooling Managing the repository's maintenance good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: match .all-contributorsrc to template JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg