Skip to content

Latest commit

 

History

History
452 lines (320 loc) · 15.9 KB

CONTRIBUTING.md

File metadata and controls

452 lines (320 loc) · 15.9 KB

Contributing to Sim Studio

Thank you for your interest in contributing to Sim Studio! Our goal is to provide developers with a powerful, user-friendly platform for building, testing, and optimizing agentic workflows. We welcome contributions in all forms—from bug fixes and design improvements to brand-new features.

Project Overview:
Sim Studio is a monorepo containing the main application (sim/) and documentation (docs/). The main application is built with Next.js (app router), ReactFlow, Zustand, Shadcn, and Tailwind CSS. Please ensure your contributions follow our best practices for clarity, maintainability, and consistency.

Table of Contents

How to Contribute

We strive to keep our workflow as simple as possible. To contribute:

  1. Fork the Repository
    Click the Fork button on GitHub to create your own copy of the project.

  2. Clone Your Fork

    git clone https://github.com/<your-username>/sim.git

  3. Create a Feature Branch
    Create a new branch with a descriptive name:

    git checkout -b feat/your-feature-name

    Use a clear naming convention to indicate the type of work (e.g., feat/, fix/, docs/).

  4. Make Your Changes
    Ensure your changes are small, focused, and adhere to our coding guidelines.

  5. Commit Your Changes
    Write clear, descriptive commit messages that follow the Conventional Commits specification. This allows us to maintain a coherent project history and generate changelogs automatically. For example:

    • feat(api): add new endpoint for user authentication
    • fix(ui): resolve button alignment issue
    • docs: update contribution guidelines

  6. Push Your Branch

    git push origin feat/your-feature-name

  7. Create a Pull Request
    Open a pull request against the main branch on GitHub. Please provide a clear description of the changes and reference any relevant issues (e.g., fixes #123).

Reporting Issues

If you discover a bug or have a feature request, please open an issue in our GitHub repository. When opening an issue, ensure you:

  • Provide a clear, descriptive title.
  • Include as many details as possible (steps to reproduce, screenshots, etc.).
  • Tag Your Issue Appropriately:
    Use the following labels to help us categorize your issue:
    • active: Actively working on it right now.
    • bug: Something isn't working.
    • design: Improvements & changes to design & UX.
    • discussion: Initiate a discussion or propose an idea.
    • documentation: Improvements or updates to documentation.
    • feature: New feature or request.

Note: If you're uncertain which label to use, mention it in your issue description and we'll help categorize it.

Pull Request Process

Before creating a pull request:

  • Ensure Your Branch Is Up-to-Date:
    Rebase your branch onto the latest main branch to prevent merge conflicts.

  • Follow the Guidelines:
    Make sure your changes are well-tested, follow our coding standards, and include relevant documentation if necessary.

  • Reference Issues:
    If your PR addresses an existing issue, include refs #<issue-number> or fixes #<issue-number> in your PR description.

Our maintainers will review your pull request and provide feedback. We aim to make the review process as smooth and timely as possible.

Commit Message Guidelines

We follow the Conventional Commits standard. Your commit messages should have the following format:

<type>[optional scope]: <description>
  • Types may include:
    • feat – a new feature
    • fix – a bug fix
    • docs – documentation changes
    • style – code style changes (formatting, missing semicolons, etc.)
    • refactor – code changes that neither fix a bug nor add a feature
    • test – adding or correcting tests
    • chore – changes to tooling, build process, etc.
    • high priority – a high priority feature or fix
    • high risk – a high risk feature or fix
    • improvement – an improvement to the codebase

Examples:

  • feat[auth]: add social login integration
  • fix[ui]: correct misaligned button on homepage
  • docs: update installation instructions

Using clear and consistent commit messages makes it easier for everyone to understand the project history and aids in automating changelog generation.

Local Development Setup

To set up your local development environment:

Option 1: Using Docker (Recommended)

Docker provides a consistent development environment with all dependencies pre-configured.

  1. Clone the Repository:

    git clone https://github.com/<your-username>/sim.git
cd sim

  2. Start the Docker Environment:

    docker compose up -d

    Or use the convenience script which handles environment setup and migrations:

    chmod +x scripts/start_simstudio_docker.sh
./scripts/start_simstudio_docker.sh

    This will:

    • Start a PostgreSQL database container
    • Build and run the Next.js application with hot-reloading
    • Set up all necessary environment variables
    • Apply database migrations automatically

  3. View Logs:

    docker compose logs -f simstudio

  4. Make Your Changes:

    • Edit files in your local directory
    • Changes will be automatically reflected thanks to hot-reloading

Option 2: Using VS Code / Cursor Dev Containers

Dev Containers provide a consistent and easy-to-use development environment:

  1. Prerequisites:

  2. Setup Steps:

    • Clone the repository: 
      git clone https://github.com/<your-username>/sim.git
cd sim
    • Open the project in VS Code
    • When prompted, click "Reopen in Container" (or press F1 and select "Remote-Containers: Reopen in Container")
    • Wait for the container to build and initialize
    • The development environment will be set up in the sim/ directory

  3. Start Developing:

    • All dependencies and configurations are automatically set up
    • Use the provided aliases (like sim-start) to run common commands
    • Your changes will be automatically hot-reloaded

  4. GitHub Codespaces:

    • This setup also works with GitHub Codespaces if you prefer development in the browser
    • Just click "Code" → "Codespaces" → "Create codespace on main"

Option 3: Manual Setup

If you prefer not to use Docker or Dev Containers:

  1. Clone the Repository:

    git clone https://github.com/<your-username>/sim.git
cd sim/sim

  2. Install Dependencies:

    • Using NPM: 
      npm install

  3. Set Up Environment:

    • Copy .env.example to .env
    • Configure database connection and other required authentication variables

  4. Set Up Database:

    • You need a PostgreSQL instance running
    • Run migrations: 
      npm run db:push

  5. Run the Development Server:

    • With NPM: 
      npm run dev

  6. Make Your Changes and Test Locally.

Email Template Development

When working on email templates, you can preview them using a local email preview server:

  1. Run the Email Preview Server:

    npm run email:dev

  2. Access the Preview:

    • Open http://localhost:3000 in your browser
    • You'll see a list of all email templates
    • Click on any template to view and test it with various parameters

  3. Templates Location:

    • Email templates are located in sim/app/emails/
    • After making changes to templates, they will automatically update in the preview

Adding New Blocks and Tools

Sim Studio is built in a modular fashion where blocks and tools extend the platform's functionality. To maintain consistency and quality, please follow the guidelines below when adding a new block or tool.

Where to Add Your Code

  • Blocks: Create your new block file under the /sim/blocks/blocks directory. The name of the file should match the provider name (e.g., pinecone.ts).
  • Tools: Create a new directory under /sim/tools with the same name as the provider (e.g., /sim/tools/pinecone).

In addition, you will need to update the registries:

  • Block Registry: Update the blocks index (/sim/blocks/index.ts) to include your new block.
  • Tool Registry: Update the tools registry (/sim/tools/index.ts) to add your new tool.

How to Create a New Block

  1. Create a New File:
    Create a file for your block named after the provider (e.g., pinecone.ts) in the /sim/blocks/blocks directory.

  2. Create a New Icon: Create a new icon for your block in the /sim/components/icons.tsx file. The icon should follow the same naming convention as the block (e.g., PineconeIcon).

  3. Define the Block Configuration:
    Your block should export a constant of type BlockConfig. For example:

    import { PineconeIcon } from '@/components/icons'
import { PineconeResponse } from '@/tools/pinecone/types'
import { BlockConfig } from '../types'

export const PineconeBlock: BlockConfig<PineconeResponse> = {
  type: 'pinecone',
  name: 'Pinecone',
  description: 'Use Pinecone vector database',
  longDescription: 'A more detailed description of what this block does and how to use it.',
  category: 'tools',
  bgColor: '#123456',
  icon: PineconeIcon,

  // If this block requires OAuth authentication
  provider: 'pinecone',

  // Define subBlocks for the UI configuration
  subBlocks: [
    // Block configuration options
  ],
}

  4. Register Your Block:
    Import and add your block to the blocks registry (/sim/blocks/index.ts) in the appropriate index file so it appears in the workflow builder.

    import { PineconeBlock } from './blocks/pinecone'

export const blocks = [
  // ... existing blocks
  PineconeBlock,
]

export const blocksByType: Record<string, BlockConfig> = {
  // ... existing blocks by type
  pinecone: PineconeBlock,
}

  5. Test Your Block:
    Ensure that the block displays correctly in the UI and that its functionality works as expected.

How to Create a New Tool

  1. Create a New Directory:
    Create a directory under /sim/tools with the same name as the provider (e.g., /sim/tools/pinecone).

  2. Create Tool Files:
    Create separate files for each tool functionality with descriptive names (e.g., fetch.ts, generate_embeddings.ts, search_text.ts) in your tool directory.

  3. Create a Types File:
    Create a types.ts file in your tool directory to define and export all types related to your tools.

  4. Create an Index File:
    Create an index.ts file in your tool directory that imports and exports all tools:

    import { fetchTool } from './fetch'
import { generateEmbeddingsTool } from './generate_embeddings'
import { searchTextTool } from './search_text'

export { fetchTool, generateEmbeddingsTool, searchTextTool }

  5. Define the Tool Configuration:
    Your tool should export a constant with a naming convention of {toolName}Tool. The tool ID should follow the format {provider}_{tool_name}. For example:

    import { ToolConfig, ToolResponse } from '../types'
import { PineconeParams, PineconeResponse } from './types'

export const fetchTool: ToolConfig<PineconeParams, PineconeResponse> = {
  id: 'pinecone_fetch', // Follow the {provider}_{tool_name} format
  name: 'Pinecone Fetch',
  description: 'Fetch vectors from Pinecone database',
  version: '1.0.0',

  // OAuth configuration (if applicable)
  provider: 'pinecone', // ID of the OAuth provider

  params: {
    // Tool parameters
  },
  request: {
    // Request configuration
  },
  transformResponse: async (response: Response) => {
    // Transform response
  },
  transformError: (error) => {
    // Handle errors
  },
}

  6. Register Your Tool:
    Update the tools registry in /sim/tools/index.ts to include your new tool:

    import { fetchTool, generateEmbeddingsTool, searchTextTool } from './pinecone'
// ... other imports

export const tools: Record<string, ToolConfig> = {
  // ... existing tools
  pinecone_fetch: fetchTool,
  pinecone_generate_embeddings: generateEmbeddingsTool,
  pinecone_search_text: searchTextTool,
}

  7. Test Your Tool:
    Ensure that your tool functions correctly by making test requests and verifying the responses.

Naming Conventions

Maintaining consistent naming across the codebase is critical for auto-generation of tools and documentation. Follow these naming guidelines:

  • Block Files: Name should match the provider (e.g., pinecone.ts)
  • Block Export: Should be named {Provider}Block (e.g., PineconeBlock)
  • Icons: Should be named {Provider}Icon (e.g., PineconeIcon)
  • Tool Directories: Should match the provider name (e.g., /tools/pinecone/)
  • Tool Files: Should be named after their function (e.g., fetch.ts, search_text.ts)
  • Tool Exports: Should be named {toolName}Tool (e.g., fetchTool)
  • Tool IDs: Should follow the format {provider}_{tool_name} (e.g., pinecone_fetch)

Guidelines & Best Practices

  • Code Style: Follow the project's ESLint and Prettier configurations. Use meaningful variable names and small, focused functions.
  • Documentation: Clearly document the purpose, inputs, outputs, and any special behavior for your block/tool.
  • Error Handling: Implement robust error handling and provide user-friendly error messages.
  • Testing: Add unit or integration tests to verify your changes when possible.
  • Commit Changes: Update all related components and registries, and describe your changes in your pull request.

Happy coding!

License

This project is licensed under the Apache License 2.0. By contributing, you agree that your contributions will be licensed under the Apache License 2.0 as well.

Contributor License Agreement (CLA)

By contributing to this repository, you agree that your contributions are provided under the terms of the Apache License Version 2.0, as included in the LICENSE file of this repository.

In addition, by submitting your contributions, you grant Sim Studio, Inc. ("The Licensor") a perpetual, irrevocable, worldwide, royalty-free, sublicensable right and license to:

  • Use, copy, modify, distribute, publicly display, publicly perform, and prepare derivative works of your contributions.
  • Incorporate your contributions into other works or products.
  • Re-license your contributions under a different license at any time in the future, at the Licensor's sole discretion.

You represent and warrant that you have the legal authority to grant these rights and that your contributions are original or you have sufficient rights to submit them under these terms.

If you do not agree with these terms, you must not contribute your work to this repository.

Thank you for taking the time to contribute to Sim Studio. We truly appreciate your efforts and look forward to collaborating with you!