New extensions do not contain a README
lemonmade opened this issue · 5 comments
IMO, it is good hygiene to create a basic README.md file in a templated project that helps guide the developer on what their new project contains, and what they need to do next.
The new extension CLI does not produce a README at all. The old CLI created one, and though it wasn’t much, it was something.
CLI 3 scaffolds an app with a generic app template. Here's an example. It contains quite a bit of info, including links and documentation.
@kumar303 personally, I don't feel the app readme solves the issue. On a readme, we have the opportunity to link to checkout-specific design guidance, API documentation, and examples. The one app-level readme has almost no mention of any kind of extension, and certainly no links to helpful documentation to get you started.
Ah, true. We can add some extension related content to that template.
@kumar303 I'll be creating some docs over here.
What I found until now is that we host several templates, I'd love to understand if we're willing to cover CLI 2 in addition to CLI3, as they use different sources for the templates.
In the meantime, I'm building a short scaffold of the readme for early feedback too
Hi
if we're willing to cover CLI 2 in addition to CLI3
Nope, just CLI 3
In the meantime, I'm building a short scaffold of the readme for early feedback too
Thanks