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

Fix README typos #4

Open
Mari0nV opened this issue Aug 23, 2022 · 0 comments
Open

Fix README typos #4

Mari0nV opened this issue Aug 23, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Mari0nV
Copy link

Mari0nV commented Aug 23, 2022

Goal

There are some typos to fix in the README.

Sentences to fix

In package.json and in this project we provide you with many thing to start your plugin development

thing -> things

keywords: Your keywords that describe your plugin.

Y -> y
because all other bullet points start with a lowercase.

main / exports: correspond to your build file that would be used by other

other -> others

We provide a changelog.json to explain all change in the template

change -> changes

it's a bag that can contains fruits. It has only one mandatory attribute, its maxSize that represent the maximum of fruit it can carry

represent -> represents

in this example, we don't want to parse and validate a metadata file.

in -> In

to indicate if the provided fileName has to be parsed

put fileName between quotes or in italic or something

Method to implements:

implements -> implement

But for model,

for the model?

D3 provides you with a data object that corresponding to one of your components for each component.

corresponding -> corresponds

You have to set in one or more  the property

put ComponentDefinition between quotes or in italic or something

Before building your plugin, your have to generate the resources of your plugin :

no space before :

@Mari0nV Mari0nV added the documentation Improvements or additions to documentation label Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant