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

Code review results #41

Closed
theenoahmason opened this issue Jun 5, 2024 · 1 comment
Closed

Code review results #41

theenoahmason opened this issue Jun 5, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@theenoahmason
Copy link
Member

index.js

  • catch block and switch block comments of initRepo method mentions git but it could be any repo type.
  • putPackage method comment has a typo on "accidentally".
  • logSuccess comment should say "prepare the relative theme path" not "final theme path".
  • start prompt message has relative help command, but it should be the full npx... command because users most likely wont be installing the package to be able to use the bin in that way.

README.md

  • first sentence in readme is a runon. End at "to get a developer started."
  • readme calls the main argument "file" but its "dir" now.
  • getting started section in readme should say "kebab-cased" not "param-cased", and remove the sentance about "This will also serve as a regular expression..."
  • probably worth explaining text replacements, license fetching, repo initialization in readme.
@theenoahmason theenoahmason added the enhancement New feature or request label Jun 5, 2024
@theenoahmason theenoahmason self-assigned this Jun 5, 2024
@theenoahmason
Copy link
Member Author

Fixed by #47

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

1 participant