Contributing

Prerequisites

Fork this repository and clone your fork:

git clone <YOUR_FORK>
cd svelte-bootstrap-icons

Set the original repo as the upstream:

git remote add upstream git@github.com:metonym/svelte-bootstrap-icons.git

Install the project dependencies by running bun install.

svelvg converts SVG files from bootstrap-icons into Svelte components.

Run bun build:lib to generate Svelte components from SVG source files.

The generated Svelte components are located in the lib folder, which is ignored by Git but published to NPM.

Documentation is auto-generated using the list of icon module names from the source library (see ICON_INDEX.md).

First, run bun build:lib once to build the library.

Then, run bun dev to preview the rendered icons.

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

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