Glad to see you here! This project is open to anyone who wishes to contribute in any way: code, doc, test, ...
This project uses pnpm as package manager, please install it before continuing.
npm i -g pnpm
git clonegit@github.com:shiyiya/oplayer.git --depth=1
cd oplayer
pnpm i
-
Create a new branch for your amazing feature.
git checkout -b feat-add-something-amazing
-
Start dev mode.
pnpm run build pnpm --filter=@oplayer/<package_name> run start pnpm run dev:exam
- standalone: http://localhost:5173/
-
Make your changes...
-
Write some test(s).
-
Check that everything is ok.
-
Commit your changes
git add . git commit -m "feat: my amazing feature"
-
Create a Pull Request
If all is ok you can create a PR, you don't need to finish your feature before publishing it, you can make a draft so that we can discuss it together.
Thanks