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

🚀 Feature: Write README.md contributors in memory, not with all-contributors-cli #1845

Closed
2 tasks done
JoshuaKGoldberg opened this issue Jan 14, 2025 · 0 comments · Fixed by #1867
Closed
2 tasks done
Assignees
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

Overview

Splitting out of #1782: right now, all-contributors-cli generate is run to populate README.md files from the .all-contributorsrc file. Which is slow. 13424ms in an example run of create-typescript-app. 🐌

It's not much code to manually write the file's contents for the user instead of going through the shell. So I'd like to do that to save time.

Additional Info

Prototyped in #1839.

I requested a first-party / official API for this in all-contributors/cli#362. Given that it's been over a year without maintainer involvement, I'm going to assume that's not going to happen anytime soon.

@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Jan 14, 2025
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jan 14, 2025
JoshuaKGoldberg added a commit that referenced this issue Jan 15, 2025
## PR Checklist

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

As with the prototype in #1839, does as close a job as possible to what
all-contributors creates internally.

Unlike the prototype, implements this in `blockAllContributors`, not in
`blockReadme`. And it adds `badges` and `sections` as addons.

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

Successfully merging a pull request may close this issue.

1 participant