Contribute

Storybook Astro is a community-driven project and contributions are welcome! Whether you're fixing a bug, adding a feature, or improving documentation, your help is appreciated.

Getting Started

Prerequisites

Node.js: 20.16.0+, 22.19.0+, or 24.0.0+
Yarn: 4+ (Berry)

Dev Environment Setup

Fork the repo at github.com/storybook-astro/storybook-astro, then clone your fork:

git clone https://github.com/YOUR-USERNAME/storybook-astro.git
cd storybook-astro

Or clone the main repo directly if you have write access:

git clone https://github.com/storybook-astro/storybook-astro.git

Install dependencies:
```
yarn install
```
Start Storybook (dev mode):
```
yarn storybook
```
Run the Astro site:
```
yarn dev
```

Running Tests

Run the full test suite before submitting a PR:

yarn test

All 17 test suites (36 tests) should pass, covering Astro, React, Vue, Svelte, Preact, Solid, and Alpine.js components.

Branching Strategy

main — Stable, deployable branch. All releases are tagged from here.
develop — Integration branch for in-progress work. PRs merge here first.
feature/* — Feature branches off develop (e.g. feature/vue-slots)
fix/* — Bug fix branches off develop
release/* — Release prep branches off develop, merged to main when ready

Workflow

Create a branch from develop: feature/your-feature or fix/your-fix
Make your changes and run yarn test
Open a PR targeting develop
Once reviewed and merged, it will be included in the next release

Code Conventions

ES Modules only — All packages use "type": "module"
Explicit file extensions — Use .ts, .tsx, .js in imports
Yarn 4+ workspaces — Use workspace:* for internal dependencies
TypeScript — Used throughout with proper types where possible

Adding a New Framework Integration

The project supports React, Vue, Svelte, Preact, Solid, and Alpine.js. To add a new framework, create an integration file in packages/@storybook-astro/framework/src/integrations/ that implements the Integration interface. See the existing integrations for examples and the AGENTS.md file for detailed guidance.

Resources

GitHub Issues — Report bugs or request features
AGENTS.md — AI-assisted development guide
CONTRIBUTING.md — Full contributor guidelines