Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 4.04 KB
Raw

Contributing to the Vercel AI SDK

We deeply appreciate your interest in contributing to our repository! Whether you're reporting bugs, suggesting enhancements, improving docs, or submitting pull requests, your contributions help improve the project for everyone.

Reporting Bugs

If you've encountered a bug in the project, we encourage you to report it to us. Please follow these steps:

  1. Check the Issue Tracker: Before submitting a new bug report, please check our issue tracker to see if the bug has already been reported. If it has, you can add to the existing report.
  2. Create a New Issue: If the bug hasn't been reported, create a new issue. Provide a clear title and a detailed description of the bug. Include any relevant logs, error messages, and steps to reproduce the issue.
  3. Label Your Issue: If possible, label your issue as a bug so it's easier for maintainers to identify.

Suggesting Enhancements

We're always looking for suggestions to make our project better. If you have an idea for an enhancement, please:

  1. Check the Issue Tracker: Similar to bug reports, please check if someone else has already suggested the enhancement. If so, feel free to add your thoughts to the existing issue.
  2. Create a New Issue: If your enhancement hasn't been suggested yet, create a new issue. Provide a detailed description of your suggested enhancement and how it would benefit the project.

Improving Documentation

Documentation is crucial for understanding and using our project effectively. You can find the content of our docs under content.

To fix smaller typos, you can edit the code directly in GitHub or use Github.dev (press . in Github).

If you want to make larger changes, please check out the Code Contributions section below. It also explains how to fix prettier issues that you might encounter during your docs changes.

Code Contributions

We welcome your contributions to our code and documentation. Here's how you can contribute:

Setting Up the Repository Locally

To set up the repository on your local machine, follow these steps:

  1. Fork the Repository: Make a copy of the repository to your GitHub account.
  2. Clone the Repository: Clone the repository to your local machine, e.g. using git clone.
  3. Install pnpm: If you haven't already, install pnpm. You can do this by running npm install -g pnpm if you're using npm. Alternatively, if you're using Homebrew (Mac), you can run brew install pnpm.
  4. Install Dependencies: Navigate to the project directory and run pnpm install to install all necessary dependencies.

Submitting Pull Requests

We greatly appreciate your pull requests. Here are the steps to submit them:

  1. Create a New Branch: Initiate your changes in a fresh branch. It's recommended to name the branch in a manner that signifies the changes you're implementing.
  2. Commit Your Changes: Ensure your commits are succinct and clear, detailing what modifications have been made and the reasons behind them.
  3. Push the Changes to Your GitHub Repository: After committing your changes, push them to your GitHub repository.
  4. Open a Pull Request: Propose your changes for review. Furnish a lucid title and description of your contributions. Make sure to link any relevant issues your PR resolves.
  5. Respond to Feedback: Stay receptive to and address any feedback or alteration requests from the project maintainers.

Fixing Prettier Issues

Tip

Run pnpm prettier-fix before opening a pull request.

If you encounter any prettier issues, you can fix them by running pnpm prettier-fix. This command will automatically fix any formatting issues in your code.

Running the Examples

  1. run pnpm install in the root
  2. run pnpm build in the root
  3. cd examples/ai-core (or another example folder)
  4. AI core examples: run e.g. pnpm tsx src/stream-text/openai.ts
  5. Other examples: run pnpm dev and go to the browser url

Thank you for contributing to the AI SDK! Your efforts make a significant difference.