We're so excited you're interested in helping with Oku! We are happy to help you get started, even if you don't have any previous open-source experience 😊
- Take a look at How to Contribute to an Open Source Project on GitHub
- Check our Github Issues to see if someone has already answered your question.
- Join our community on Discord and feel free to ask us your questions
- [Min Nodejs 20] & PNPM >= 8.13.0 installed
- IDE: VSCode(recommended) or equivalent IDE
Note: If you have nvm, you can run nvm i to install the required version.
- Fork the oku-ui repository
- Install the project dependencies.
pnpm install - If you are going to deal with packages in
./packages-core, you should install pnpm there too. It is different from root.cd ./packages-core && pnpm install
- pergel - CLI and Pergel core packages
- nuxt module
- Before submitting a pull request make sure all tests have passed
- Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request
- Make sure the PR title follows conventional commits specification
Oku is made possible by a passionate team and a strong community of developers. If you have any questions or would like to get more involved in the Oku community you can check out: