So you want to contribute to the project? Well, this guide list some things you have to know before you start.
As Yomu is a monorepo it house multiple packages within it. We only need to focus on two.
The Core and UI packages are not packages where you will have to contribute to them independently.
The Core package is used across all packages and the UI package is only for Shadcn components to be used in the web client.
So if you think a method will be reused across packages move it to the core package. And if you want to add a new Shadcn component, do it in the UI package.
Tip
We recommend using the GitHub Flow for contributing to this project.
You see a problem? check if there is an issue or pull request addressed to it, or create one and start working on it on your own fork of the repository.
After you finish the work you can open a pull request with the changes. I will try to review it as soon as possible. and merge it to main.
The same process applies if you have a feature or an enhancement request.