docs/content/en/docs/contributing/index.md
Hello! Thank you for your interest in contributing to this project. This guide will help you get started.
Download Visual Studio, and follow the instructions here: https://rust-lang.github.io/rustup/installation/windows-msvc.html#walkthrough-installing-visual-studio-2022
Make sure to install Windows SDK and C++ build tools when installing Visual Studio.
Open PowerShell
Install scoop
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
Install git, Node.js, rustup, msvc through scoop
scoop install git nodejs rustup
# For Rust dependencies
# Not required if you are not going to develop on either crates or apps/tamagotchi
scoop install main/rust-msvc
# Rust & Windows specific
rustup toolchain install stable-x86_64-pc-windows-msvc
rustup default stable-x86_64-pc-windows-msvc
Install pnpm through corepack
corepack enable
corepack prepare pnpm@latest --activate
Open Terminal, (or iTerm2, Ghostty, Kitty, etc.)
Install git, node through brew
brew install git node
Install pnpm through corepack
corepack enable
corepack prepare pnpm@latest --activate
Open Terminal
Follow nodesource/distributions: NodeSource Node.js Binary Distributions to install node
Follow Git to install git
Install pnpm through corepack
corepack enable
corepack prepare pnpm@latest --activate
If you would love to help to develop the desktop version, you will need those dependencies:
sudo apt install \
libssl-dev \
libglib2.0-dev \
libgtk-3-dev \
libjavascriptcoregtk-4.1-dev \
libwebkit2gtk-4.1-dev
::: 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
Click on the Fork button on the top right corner of the moeru-ai/airi page.
git clone https://github.com/<your-github-username>/airi.git
cd airi
git checkout -b <your-branch-name>
corepack enable
pnpm install
# For Rust dependencies
# Not required if you are not going to develop on either crates or apps/tamagotchi
cargo fetch
::: tip
We would recommend to install @antfu/ni to make your script simpler.
corepack enable
npm i -g @antfu/ni
Once installed, you can
ni for pnpm install, npm install and yarn install.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.
:::
::: warning
Please make sure lint (static checkers) and TypeScript compilers are satisfied:
pnpm lint && pnpm typecheck
:::
::: tip
If you have @antfu/ni installed, you can use nr to run the commands:
nr lint && nr typecheck
:::
git add .
git commit -m "<your-commit-message>"
git push origin <your-branch-name> -u
You should be able to browse the branch on your fork repository.
::: tip
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/moeru-ai/airi.git
:::
Navigate to moeru-ai/airi 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.
Congratulations! You made your first contribution to this project. You can now wait for the maintainers to review your pull request.