repo-guidance

Navigate the Composio SDK monorepo layout, branching, changesets, and PR workflow conventions.

30.0k|4.8k|Updated Feb 23, 2024
One-click install
npx skills add https://github.com/ComposioHQ/composio --skill repo-guidance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-guidance
Source: https://github.com/ComposioHQ/composio/tree/main/.agents/skills/repo-guidance
Command: npx skills add https://github.com/ComposioHQ/composio --skill repo-guidance

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Contributors working across the Composio SDK monorepo often struggle to know where code belongs, which branch to target, when to add changesets, and which files are generated or read-only, leading to misplaced changes and broken release metadata.

Core Features & Use Cases

  • Repository Orientation: Explains the layout of the ts/, python/, docs/, and .agents/skills/ directories so changes land in the right package.
  • Branch and PR Workflow: Documents the next base branch convention, feature branch creation, and PR targeting rules.
  • Changeset and Generated-File Rules: Clarifies when changesets are required, which packages are ignored by Changesets, and which vendor or generated files must not be edited.
  • Use Case: When preparing a pull request that touches both the TypeScript SDK and docs, use this Skill to confirm the correct base branch, decide whether a changeset is needed, and avoid editing generated files.

Quick Start

Ask the agent to explain where a new feature for the Python SDK should live and whether the change requires a changeset before opening a PR.

Frequently Asked Questions about repo-guidance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I decide where code belongs in the Composio monorepo?

TypeScript SDK, providers, CLI, and examples live in ts/, while the Python SDK and its tests live in python/. Documentation and generated API data go in docs/. The repo-guidance reference maps each directory so changes land in the correct package.

Which branch should I target for pull requests in the Composio repo?

Target PRs at the next branch, which is the default active base for SDK and docs work. Create feature branches from origin/next unless a different base is explicitly specified.

When do I need to add a changeset in the Composio repository?

Add a changeset for changes to published TypeScript packages. Skip changesets for docs-only, tests-only, or validation-only changes, and never target @composio/cli or @composio/cli-local-tools since they are ignored by Changesets.

Can I edit files in the ts/vendor directory?

No, the ts/vendor/ trees are read-only references and must not be edited. Generated outputs should remain owned by their generator, and generated client bumps require verifying the package version resolves before updating pins.

What build and test commands does the Composio monorepo use?

Root commands include pnpm install, build, lint, typecheck, and test, with tooling managed through mise. Python work runs from the python/ directory using make targets such as env, fmt, chk, tst, and build.