chore(template): add comments about deleting boilerplates

storyblok / field-plugin

Create and deploy Storyblok Field Plugin

https://www.storyblok.com/docs/plugins/field-plugins/introduction

25 stars 3 forks source link

chore(template): add comments about deleting boilerplates #211

Closed eunjae-lee closed 1 year ago

eunjae-lee commented 1 year ago

What?

This PR adds comments about deleting the boilerplates.

Why?

JIRA: EXT-1602

After seeing the code, they may want to start from the blank state, but don't know what to do first.

vercel[bot] commented 1 year ago

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

Name	Status	Preview	Comments	Updated (UTC)
plugin-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 7, 2023 8:06am

eunjae-lee commented 1 year ago

@johannes-lindgren I've left the JS template as-is, because it's not as easy as other templates to do this change..

Also, I didn't put an empty FieldPlugin component for replacement, because I'm going to do it in a separate PR. If I do it in here, git is likely going to mess up the commit history.

renaming FieldPlugin to FieldPluginExample
adding a new file named FieldPlugin

These two things better not happen together in a single commit (or a PR squashed)