mirror of
https://github.com/actionbook/actionbook.git
synced 2026-09-19 03:28:06 +08:00
Adcent
40 lines
1.3 KiB
Plaintext
40 lines
1.3 KiB
Plaintext
---
|
|
title: "Contributing"
|
|
description: "How to contribute to Actionbook"
|
|
---
|
|
|
|
## Development
|
|
|
|
This public repository contains the CLI, SDK, MCP server, JSON UI, docs, and example projects. The internal build pipeline is no longer part of the open-source repo.
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 20+
|
|
- pnpm 10+
|
|
- Rust stable for `packages/actionbook-rs`
|
|
|
|
### First-time Setup
|
|
|
|
1. Install dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
2. Run the checks that match the package you changed:
|
|
|
|
```bash
|
|
pnpm --filter @actionbookdev/sdk test
|
|
pnpm --filter @actionbookdev/mcp build
|
|
pnpm --filter @actionbookdev/tools-ai-sdk test
|
|
pnpm --filter @actionbookdev/json-ui build
|
|
cargo test --manifest-path packages/actionbook-rs/Cargo.toml
|
|
```
|
|
|
|
## Contributing
|
|
|
|
- **[Read the repository guide](https://github.com/actionbook/actionbook/blob/main/CONTRIBUTING.md)** - See branching, commit message, and validation conventions.
|
|
- **[Request a Website](https://actionbook.dev/request-website)** - Suggest websites you want Actionbook to index.
|
|
- **[Join the Community](https://actionbook.dev/discord)** - Join our Discord to get help, share your agents, and discuss ideas.
|
|
- **[Join the Waitlist](https://actionbook.dev)** - We are currently in private beta. Join if you are interested in contributing or using Actionbook.
|