mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
chore: update CONTRIBUTING.md, add MAINTAINERS.md [ci skip]
This commit is contained in:
parent
81593b6602
commit
b00e4316fd
4 changed files with 12 additions and 20 deletions
|
@ -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
|
||||
|
|
5
MAINTAINERS.md
Normal file
5
MAINTAINERS.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
# Maintainers
|
||||
|
||||
Eric Liu - eric.young.liu@ibm.com
|
||||
|
||||
Josef Aidt - josef.aidt@gmail.com
|
|
@ -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
|
||||
|
||||
|
|
15
package.json
15
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue