Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (85 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

124 lines (85 loc) · 3.79 KB

Contributing

Thanks for your interest in contributing to Hyperbolic! We're happy to have you here.

Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.

If you need any help, feel free to reach out to @hyperbolic_labs.

About this repository

This repository is a monorepo.

Structure

This repository is structured as follows:

packages
  └─ ai-sdk-provider
      └─ Hyperbolic provider integration for the Vercel AI SDK.

tooling
  ├─ eslint
  |   └─ shared, fine-grained, eslint presets
  ├─ prettier
  |   └─ shared prettier configuration
  ├─ tailwind
  |   └─ shared tailwind configuration
  └─ typescript
      └─ shared tsconfig you can extend from

Development

Fork this repo

You can fork this repo by clicking the fork button in the top right corner of this page.

Clone on your local machine

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

Navigate to project directory

cd hyperbolic-monorepo

Create a new Branch

git checkout -b my-new-branch

Install dependencies

pnpm i

Run a package

  1. To run dev watch server for the ai-sdk-provider package:
pnpm dev:ai-sdk-provider dev

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features

  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)

  • refactor: any code related change that is not a fix nor a feature

  • docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib)

  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies

  • test: all changes regarding tests (adding new tests or changing existing ones)

  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)

  • chore: all changes to the repository that do not fit into any of the above categories

    e.g. feat(ai-sdk-provider): add support for new thing

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

Requests for new components

If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out.

ai-sdk-provider

The ai-sdk-provider package is deployed to npm and enables the community to use Hyperbolic in the Vercel AI SDK.

Any changes to the ai-sdk-provider should be made in the packages/ai-sdk-provider directory. If you can, it would be great if you could add tests for your changes.

Testing

Tests are written using Vitest. You can run all the tests from the root of the repository.

pnpm test:ai-sdk-provider

Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.