Contribute a component
Anyone can add assets to the community component index. Maintainers can submit a short pull request in GitHub to add components to the index.
In the index folder of the carbon-website GitHub repo, open your team folder. Create a folder if your team doesn’t have one yet.
Add file(top right), then
Create new file.
Name your file
component-name.yml, where component-name is the name of your component.
Copy and paste the following template into the
Edit new filesection of the page and fill out the correct information for your component.name: component namewebsite_url: >-url of documentation / guidance page (if any)code_url: >-url of component code on GitHubmaintainer: name of maintainer teamdescription: >-short description of purpose and usage of componentframework: choose one of Vanilla | Angular | React | Vue
Once done, click the green
Commit new filebutton at the bottom.
After submitting the PR for the data, you should upload a thumbnail image.
- Go back to your team folder in the index.
- Inside your team folder, open the
- In the top right, click
Upload filesto upload your image to that page then submit the PR. Note: name your image file with the same name as the component (e.g.
And you’re done! The Carbon team will review and merge the PR.
If you’re unsure about how to make a PR through GitHub, create an issue in the repo instead and we’ll help you out. Be sure to include all the necessary component information and images.