Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 37 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,70 @@
# Contributing

Thanks for contributing to OpenChatWidget.
Hey, it's Matt. I maintain the Open Chat Widget repo. Thanks for considering contributing. People like you make the project better.

The goal of this project is to keep the core AI chat widget simple, portable, and easy to understand.
Please consider joining the [Discord](https://discord.gg/jA4vcJKECy), that's where contributors and I hang out.

## What to work on
## Finding issues to work on

Good contributions:
If you're interested in contributing, please take a look at the project's [issues tab](https://github.com/Open-Chat-Widget/openchatwidget/issues) to see what work needs to be done. Issues labeled `good first issue` are a great place to start.

- bug fixes
- documentation improvements
- example app improvements
- small, durable SDK improvements
- backend examples for common Node stacks
## Local setup

Please avoid broadening the project unnecessarily. Features like live chat, dashboards, or Convex-specific product layers should not be added unless they are explicitly part of the roadmap.
### 1. Fork and clone the repo
Fork the `openchatwidget` repo, then clone your fork.

## Local setup
```bash
git clone git@github.com:<your-github-username>/openchatwidget.git
cd openchatwidget
```

Install dependencies:
### 2. Install SDK dependencies

```bash
cd sdk
npm install
```

### 3. Start the local dev environment

```bash
cd examples/vite-express-app
npm install
npm run dev
```

Build the SDK:
This starts:

- the Vite sandbox app on `http://127.0.0.1:5173`
- the local Express agent on `http://localhost:8787`

The sandbox renders the widget directly
from the local SDK source, so changes inside `sdk/widget/src` should show up there while you develop.

## Opening a pull request

1. Create a branch for your work.

```bash
cd sdk
npm run build
git checkout -b my-feature-branch
```

Build the example app:
2. Make your changes.
3. Run the checks in `sdk/`:

```bash
cd examples/vite-express-app
npm run build
npm run lint
npm run format:check
```

## Pull requests
4. Commit your changes with a clear message.
5. Push your branch to GitHub.
6. Open a pull request against `main`.

Before opening a PR:
Before opening a PR, please make sure to:

- keep changes focused
- update docs when behavior changes
- verify relevant builds still pass
- verify relevant checks and builds still pass
- explain the reasoning behind non-trivial changes
- include screenshots or short videos for UI changes when helpful

If you are proposing a larger feature, open an issue first so the scope can be discussed before implementation.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Open Chat Widget lets you drop in a AI chat client right in your product. You ju

### Why Open Chat Widget

I'll be honest, there's a TON of chatbot frameworks out there, why use us? You came here because you want a working chat, not a new framework to learn. Open Chat Widget gives you a prod ready chat out of the box. We're opinionated about design and UX so you can skip the decisions and focus on what matters, building your agent.

- **Plug and play** - A single component you drop in to your website. You get access to feature rich AI chat with text streaming, web search, tool use, etc. out of the box. Set up is a few lines of code.

- **Works with AI SDK** — Build custom agents with [Vercel AI SDK](https://ai-sdk.dev/). Use any LLM model and create custom workflows. Works directly with existing AI-SDK endpoints.
Expand Down Expand Up @@ -118,7 +120,7 @@ Read our roadmap to see what features are coming next. If you're interested in c

## [Community](https://discord.gg/jA4vcJKECy)

Join our Discord! That's where the community hangs out. Share your projects, ask quesitons, or just hang out with us!
Join us on Discord—share what you're building, get help, or just say hi. We'd love to have you.

## [License](./LICENSE)

Expand Down
Loading
Loading