Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
200 lines (145 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

200 lines (145 loc) · 4.36 KB
Raw

Start contributing to UnRTEL

Hello! Thank you for your interest in contributing to this project. This guide will help you get started.

Prerequisites

Windows setup

  1. Open PowerShell

  2. Install scoop

    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression

  3. Install git, node through scoop

    scoop install git nodejs

  4. Install pnpm through corepack

    corepack enable
corepack prepare pnpm@latest --activate
macOS setup

  1. Open Terminal, (or iTerm2, Ghostty, Kitty, etc.)

  2. Install git, node through brew

    brew install git node

  3. Install pnpm through corepack

    corepack enable
corepack prepare pnpm@latest --activate
Linux setup

  1. Open Terminal

  2. Follow nodesource/distributions: NodeSource Node.js Binary Distributions to install node

  3. Follow Git to install git

  4. Install pnpm through corepack

    corepack enable
corepack prepare pnpm@latest --activate

If you have already contributed to this project before

Warning

If you haven't clone this repository, skip this section.

Make sure your local repository is up to date with the upstream repository:

git fetch -all
git checkout main
git pull upstream main --rebase

If you have a working branch, to make your branch up to date with the upstream repository:

git checkout <your-branch-name>
git rebase main

Fork this project

Click on the Fork button on the top right corner of the unrteljs/unrtel page.

Clone

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

Create your working branch

git checkout -b <your-branch-name>

Install dependencies

corepack enable
pnpm install

Note

We would recommend to install @antfu/ni to make your script simpler.

corepack enable
npm i -g @antfu/ni

Once installed, you can

  • use ni for pnpm install, npm install and yarn install.
  • use nr for pnpm run, npm run and yarn run.

You don't need to care about the package manager, ni will help you choose the right one.

Choose the application you want to develop on

Playground

pnpm -F @unrteljs/playground dev

Note

For @antfu/ni users, you can

nr -F @unrteljs/playground dev

Commit

Before commit

Caution

Please make sure lint (static checkers) and TypeScript compilers are satisfied:

pnpm packages:stub && pnpm lint && pnpm typecheck

Note

If you have @antfu/ni installed, you can use nr to run the commands:

nr packages:stub && nr lint && nr typecheck

Commit

git add .
git commit -m "<your-commit-message>"

Push to your fork repository

git push origin <your-branch-name> -u

You should be able to browse the branch on your fork repository.

Note

If this is your first time contributing with this project, you need to add the upstream repository too:

git remote add upstream https://github.com/proj-airi/webai-realtime-voice-chat.git

Creating Pull Request

Navigate to unrteljs/unrtel page, click on the Pull requests tab, and click on the New pull request button, click on the Compare across forks link, and select your fork repository.

Review the changes, and click on the Create pull request button.

Whooo-ya! You made it!

Congratulations! You made your first contribution to this project. You can now wait for the maintainers to review your pull request.