diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b759e9c..318b98a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,8 +83,8 @@ Each component should adopt the following structure: src/Component │ └───Component.svelte // main component -└───Component.Skeleton.svelte // Skeleton component (if any) -└───index.js // export components (e.g. `Component.svelte`, `Component.Skeleton.svelte`) +└───ComponentSkeleton.svelte // Skeleton component (if applicable) +└───index.js // export components ``` ### Editing a component @@ -93,10 +93,10 @@ If adding or editing an exported component prop, be sure to annotate its value u ```js /** - * Set to `true` to disable the tab - * @type {boolean} [disabled=false] + * Specify the size of the component + * @type {"sm" | "default" | "lg"} */ -export let disabled = false; +export let size = "default"; ``` ### Creating a component diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 00000000..4a6a2bc5 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,5 @@ +# Maintainers + +Eric Liu - eric.young.liu@ibm.com + +Josef Aidt - josef.aidt@gmail.com diff --git a/README.md b/README.md index a6233046..b8839eda 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ See [webpack.config.js](examples/webpack/webpack.config.js) in [examples/webpack ### TypeScript support -The component library ships with TypeScript definitions ([types/index.d.ts](types/index.d.ts)). +[TypeScript definitions](types) are generated by [sveld](https://github.com/IBM/sveld). ## Contributing diff --git a/package.json b/package.json index b1491cbc..c49f2964 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "carbon-components-svelte", "version": "0.22.0", "license": "Apache-2.0", + "author": "IBM", "description": "Svelte implementation of the Carbon Design System", "svelte": "./src/index.js", "main": "./lib/index.js", @@ -76,19 +77,5 @@ "src", "types", "css" - ], - "contributors": [ - { - "name": "Eric Liu", - "email": "eric.young.liu@ibm.com" - }, - { - "name": "Josef Aidt", - "email": "josef.aidt@gmail.com" - }, - { - "name": "Adan Ulloa", - "email": "adanug@mx1.ibm.com" - } ] }