chore: update CONTRIBUTING.md, add MAINTAINERS.md [ci skip]

This commit is contained in:
Eric Liu 2020-11-19 14:44:50 -08:00
commit b00e4316fd
4 changed files with 12 additions and 20 deletions

View file

@ -83,8 +83,8 @@ Each component should adopt the following structure:
src/Component src/Component
└───Component.svelte // main component └───Component.svelte // main component
└───Component.Skeleton.svelte // Skeleton component (if any) └───ComponentSkeleton.svelte // Skeleton component (if applicable)
└───index.js // export components (e.g. `Component.svelte`, `Component.Skeleton.svelte`) └───index.js // export components
``` ```
### Editing a component ### Editing a component
@ -93,10 +93,10 @@ If adding or editing an exported component prop, be sure to annotate its value u
```js ```js
/** /**
* Set to `true` to disable the tab * Specify the size of the component
* @type {boolean} [disabled=false] * @type {"sm" | "default" | "lg"}
*/ */
export let disabled = false; export let size = "default";
``` ```
### Creating a component ### Creating a component

5
MAINTAINERS.md Normal file
View file

@ -0,0 +1,5 @@
# Maintainers
Eric Liu - eric.young.liu@ibm.com
Josef Aidt - josef.aidt@gmail.com

View file

@ -121,7 +121,7 @@ See [webpack.config.js](examples/webpack/webpack.config.js) in [examples/webpack
### TypeScript support ### 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 ## Contributing

View file

@ -2,6 +2,7 @@
"name": "carbon-components-svelte", "name": "carbon-components-svelte",
"version": "0.22.0", "version": "0.22.0",
"license": "Apache-2.0", "license": "Apache-2.0",
"author": "IBM",
"description": "Svelte implementation of the Carbon Design System", "description": "Svelte implementation of the Carbon Design System",
"svelte": "./src/index.js", "svelte": "./src/index.js",
"main": "./lib/index.js", "main": "./lib/index.js",
@ -76,19 +77,5 @@
"src", "src",
"types", "types",
"css" "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"
}
] ]
} }