Get Started

How to Contribute

Take care to read all contributions guidelines before you begin!

1. Learn how to contribute to open source .
2. Follow a step-by-step guide to practice your first contribution.
3. Locate an open issue on GitHub . Post a comment letting us know you wish to volunteer.
4. Optionally, you may coordinate efforts on the #contributors channel within Discord .
5. A member of the Skeleton team will assign the issue to you and help outline requirements.
6. Complete the work and submit a pull request per the requirements on this page.

NOTE: non-trivial PRs submitted without our prior consent will be denied. Repeat offenders will be blocked.

Using PNPM

Skeleton makes use of PNPM and PNPM workspaces to maintain all projects within the Skeleton monorepo.

1. Install PNPM on your local computer.
2. Fork the Skeleton monorepo via the option on GitHub.
3. Use Git to clone the forked project to your local machine.
4. Run pnpm i from the root to install the required dependencies.
5. Point your terminal at one of the /sites, /packages or /playgrounds projects detailed below.
6. Run pnpm dev to start a local dev server for each project.

Monorepo Structure

Sites

Public facing websites that are deployed and hosted for users to browse.

Packages

Modular Skeleton packages distributed via NPM.

Playgrounds

Isolated sandbox environments for developing, testing and experimenting.

Branch

Create and target all pull requests against the main branch unless otherwise instructed.

PR Branch Conventions

Please use the following naming convention when creating your pull request.

Keep branch names short and semantic, and use kebab-case to separate words:

Changesets

Changesets are used to automatically generate the changelog for each release.

• Any contributions made within /packages must contain a Changeset
• Any contributions made within /sites should not include a Changeset.

Follow these instructions to generate a changeset:

1. Navigate to the root of the Skeleton monorepo.
2. Run pnpm changeset to trigger the Changeset CLI.
3. Select the packages that are affected by your changes.
4. Select the type of version bump required (major, minor, patch).
5. Provide a short description of the changes made.

Changesets use semantic versioning. We recommend the following convention.

Changeset descriptions will appear verbatim on the corresponding CHANGELOG.md. Keep it short, semantic, and and include the same branch prefix .

---
'@skeletonlabs/skeleton-svelte': minor
---

feat: Added `Avatar` component.

Tooling

Skeleton makes use of the following technology to improve the developer experience. It’s recommended you run these tools before flagging the PR as “ready for review” on GitHub.

Root Commands

Run the following commands in the monorepo root. Each will run recursively for supported packages.