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: Add a --guide option for including a contributing walkthrough #982

Closed
2 tasks done
JoshuaKGoldberg opened this issue Oct 24, 2023 · 3 comments · Fixed by #983
Closed
2 tasks done

🚀 Feature: Add a --guide option for including a contributing walkthrough #982

JoshuaKGoldberg opened this issue Oct 24, 2023 · 3 comments · Fixed by #983
Assignees
@JoshuaKGoldberg
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Oct 24, 2023 •
edited
Loading

Bug Report Checklist

Overview

I wrote https://www.joshuakgoldberg.com/blog/contributing-to-a-create-typescript-app-repository with a whole bunch of instructions and FAQs for contributing to a repo scaffolded with create-typescript-app. It'd be nice to have a link to it in the docs.

Though, I don't want to add that link to repos created under different owners. It feels overly self-promote-y. So I'll add a CLI option defaults to true iff owner is me that later on can be inferred from the text as a followup.

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Oct 24, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Oct 24, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 24, 2023
Closed
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Documentation: Mention my large contributing blog post if owner is JoshuaKGoldberg 🚀 Feature: Add a --guide option for including a contributing walkthrough Oct 25, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 26, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Oct 26, 2023
@JoshuaKGoldberg
feat: add --guide options (#983)
7f1350e 
## PR Checklist

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

Adds `--guide` with the accompanying `--guide-title`, similar to the
existing `--logo` and `--logo-alt` options. It will be inferred from an
existing `.github/DEVELOPMENT.md` when present.
@github-actions
Copy link

🎉 This is included in version v1.40.0 🎉

The release is available on:

Cheers! 📦🚀

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 11, 2023
Closed
3 tasks
@JoshuaKGoldberg
Copy link
Owner Author

@all-contributors please add @JoshuaKGoldberg for ideas.

🤖 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 issue Jan 14, 2024
Merged
@allcontributors AllContributors
Copy link
Contributor

@JoshuaKGoldberg

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

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

JoshuaKGoldberg pushed a commit that referenced this issue Jan 14, 2024
@allcontributors
docs: add joshuakgoldberg as a contributor for ideas (#1238)
92454e5 
Adds @JoshuaKGoldberg as a contributor for ideas.

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

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: documentation Improvements or additions to docs 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: add --guide options JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg