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

Refine CLI flag descriptions for clarity #8545

Merged
merged 16 commits into from
Sep 22, 2023
Merged

Refine CLI flag descriptions for clarity #8545

merged 16 commits into from
Sep 22, 2023

Conversation

jacobdalamb
Copy link
Contributor

Changes

  • Updated wording of create-astro CLI flags

Testing

N/A

Docs

@withastro/maintainers-docs should probably add docs for this

@changeset-bot
Copy link

changeset-bot bot commented Sep 13, 2023

⚠️ No Changeset found

Latest commit: 2514716

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the pkg: create-astro Related to the `create-astro` package (scope) label Sep 13, 2023
@jacobdalamb jacobdalamb requested a review from a team as a code owner September 13, 2023 19:25
Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for these improvements! I know people will be thrilled with them.

@natemoo-re
Copy link
Member

Waiting for a review from @withastro/maintainers-docs which I've been told is coming tomorrow!

@sarah11918
Copy link
Member

Hi @jacobthesheep ! Can you please revise this PR to only include the new options you're adding, and no changes to existing flags? Thanks!

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting that only new flags be added; removing changes to existing content.

@jacobdalamb
Copy link
Contributor Author

Requesting that only new flags be added; removing changes to existing content.

I'm not adding new flags. I just updated the wording for existing flags.

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching these typos and adding some missing flags, @jacobthesheep !

I'm not sure about the formatting changes though, that doesn't seem right to me, so let me know if I'm missing something.

packages/create-astro/src/actions/help.ts Outdated Show resolved Hide resolved
packages/create-astro/README.md Outdated Show resolved Hide resolved
packages/create-astro/README.md Outdated Show resolved Hide resolved
jacobdalamb and others added 3 commits September 22, 2023 09:39
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@jacobdalamb
Copy link
Contributor Author

Thanks for catching these typos and adding some missing flags, @jacobthesheep !

I'm not sure about the formatting changes though, that doesn't seem right to me, so let me know if I'm missing something.

Sorry about that. Thanks for catching those.

@sarah11918 sarah11918 dismissed their stale review September 22, 2023 16:47

still for Nate to do one final check!

Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the missing info and the typo fixes! Appreciate it.

@natemoo-re natemoo-re merged commit 139b0f5 into withastro:main Sep 22, 2023
13 checks passed
@jacobdalamb jacobdalamb deleted the chore/create-astro-cli-flags branch September 22, 2023 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: create-astro Related to the `create-astro` package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants