@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 07:15 UTC

next
md 59 lines 2.28 KB
Rendered Raw
1 # Repository Workflow
2
3 ## Branches
4
5 - Default active base: `next`.
6 - Create feature branches from `origin/next` unless the user names another base.
7 - Target PRs at `next` for SDK and docs work.
8
9 ## Layout
10
11 - `ts/`: TypeScript SDK, providers, CLI, examples, and runtime E2E tests.
12 - `python/`: Python SDK, providers, tests, nox sessions, and release scripts.
13 - `docs/`: Fumadocs site, generated API/toolkit data, changelogs, and docs automation.
14 - `.agents/skills/`: canonical local skill tree.
15 - `docs/agent-guidance/`: neutral docs-agent context and workflow prompts.
16 - `docs/decisions/`: neutral docs decisions and plans.
17
18 ## Tooling
19
20 Use `mise install` for Node, Bun, pnpm, Python, and uv. pnpm is managed through mise.
21
22 Common root commands:
23
24 ```bash
25 pnpm install
26 pnpm build
27 pnpm build:packages
28 pnpm lint
29 pnpm typecheck
30 pnpm test
31 pnpm test:e2e
32 pnpm test:e2e:cli
33 bun run validate:agent-skills
34 ```
35
36 Python commands run from `python/`:
37
38 ```bash
39 make env
40 source .venv/bin/activate
41 make fmt
42 make chk
43 make tst
44 make snt
45 make build
46 ```
47
48 ## Changesets
49
50 - Public SDK behavior changes need a Changesets note for each affected TypeScript package and/or the private `@composio/python-sdk` marker. Python core and supported providers share one stable release train.
51 - `@composio/cli` is ignored by Changesets. Never target it in a changeset while it remains ignored; use the `cli-release` skill for beta builds and stable promotion.
52 - Repo guidance, docs-only, tests-only, internal validation and CLI-only changes do not require an SDK note. Explicit behavior exemptions need a meaningful `<!-- sdk-release-note-exempt: meaningful reason of at least 20 characters -->` comment in the PR body.
53 - Stable and beta SDKs use **SDK release** on protected `next`: a member issue request, one release PR that a repository writer approves and a person merges, and a tag run that publishes the PR-built candidates. Requesters may approve only with repository admin permission at release time; the PR author remains excluded. Recover with **Re-run failed jobs**. Read `ts/docs/internal/release.md` before operating it.
54
55 ## Generated And Vendor Files
56
57 - Do not edit `ts/vendor/`; those trees are read-only references.
58 - Keep generated outputs owned by their generator.
59 - For generated client bumps, verify the package version resolves before updating pins.