Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
151 lines (103 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

151 lines (103 loc) · 3.42 KB

Contributing

Note: before submitting a pull request (PR), it is recommended to first file an issue.

Prerequisites

This project requires Node.js (version 12 or greater) and Yarn (version 1 or greater).

Project set-up

Fork the repo and clone your fork:

git clone <YOUR_FORK>
cd carbon-components-svelte

Set the original repository as the upstream:

git remote add upstream git@github.com:IBM/carbon-components-svelte.git
# verify that the upstream is added
git remote -v

Install

Install the project dependencies:

# carbon-components-svelte/
yarn install

Documentation set-up

Component documentation is located in the docs folder. The website is built using svite, routify, and MDsveX. You will need to create a symbolic project link in order to see live changes reflected when developing locally.

First, create a symbolic link at the root of the project folder:

# carbon-components-svelte/
yarn link

Go into the docs folder:

cd docs

Link "carbon-components-svelte":

yarn link "carbon-components-svelte"
yarn install

If linked correctly, any change to a component in the src folder should be reflected in the docs site.

Development workflow

Preview changes to components from the src folder in the documentation website located in docs/.

In the docs folder, run:

yarn dev

The site should be served at http://localhost:3000/ (or the next available port).

Component Format

Each component should adopt the following structure:

src/Component
│
└───Component.svelte // main component
└───ComponentSkeleton.svelte // Skeleton component (if applicable)
└───index.js // export components

Editing a component

If adding or editing an exported component prop, be sure to annotate its value using JSDoc conventions.

/**
 * Specify the size of the component
 * @type {"sm" | "default" | "lg"}
 */
export let size = "default";

Creating a component

First, submit an issue.

If creating a new component, don't forget it from src/index.js:

export { CopyButton } from "./CopyButton";
export { ComboBox } from "./ComboBox";
+ export { FixedComboBox } from "./FixedComboBox";
export {
  ComposedModal,
  ModalHeader,
  ModalBody,
  ModalFooter,
} from "./ComposedModal";

Build

Verify that you can build the library by running the following command at the project root:

# carbon-components-svelte/
yarn prepack

This does several things:

  • uses node-sass to pre-compile CSS StyleSheets in the css folder
  • uses Rollup to bundle the Svelte components in src in ESM/UMD formats; emitted to lib
  • uses a Rollup plugin to:
    • generate component documentation in Markdown format (COMPONENT_INDEX.md)
    • generate TypeScript definitions (types/index.d.ts)

Submit a Pull Request

Sync Your Fork

Before submitting a pull request, make sure your fork is up to date with the latest upstream changes.

git fetch upstream
git checkout master
git merge upstream/master

Submit a PR

After you've pushed your changes to remote, submit your PR. Make sure you are comparing <YOUR_USER_ID>/feature to origin/master.