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

chore(apps/cli): update README.md template in starter boilerplate for codemod init #1443

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

amirabbas-gh
Copy link
Collaborator

📚 Description

This PR modifies the README.md template generated by the codemod init command in the CLI. The update ensures that the starter boilerplate now includes the latest format for the README.md file, providing a more accurate and standardized setup for new projects.
This change improves the quality of the initial project structure created by the CLI but does not affect any functional aspects of the tool itself.


🧪 Test Plan

  • Ran the codemod init command locally to verify that the updated README.md template is applied correctly.
  • Checked the generated template for consistency with the latest standards.

Copy link

vercel bot commented Jan 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
codemod ⬜️ Ignored (Inspect) Visit Preview Jan 10, 2025 2:43pm

Copy link

pkg-pr-new bot commented Jan 10, 2025

Open in Stackblitz

npm i https://pkg.pr.new/codemod@1443

commit: f6a7026

return `
This is a [Codemod](https://codemod.com) created with [\`\`\`codemod init\`\`\`](https://docs.codemod.com/deploying-codemods/cli#codemod-init).
Copy link
Contributor

Choose a reason for hiding this comment

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

We use Codemod (with capital 'C') to refer to the company/platform, and codemod (with lowercase 'c') to refer to the technology/codemod scripts.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for mentioning it 🙏
I will fix it

@amirabbas-gh amirabbas-gh merged commit d0c2110 into main Jan 10, 2025
11 checks passed
@amirabbas-gh amirabbas-gh deleted the improve_cli branch January 10, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants