Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 1.22 KB

Contributing 💜

Glad to see you here! This project is open to anyone who wishes to contribute in any way: code, doc, test, ...

Prerequisites

This project uses pnpm as package manager, please install it before continuing.

npm i -g pnpm

Clone & Install

git clonegit@github.com:shiyiya/oplayer.git --depth=1
cd oplayer
pnpm i

Development workflow

  1. Create a new branch for your amazing feature.

    git checkout -b feat-add-something-amazing
  2. Start dev mode.

    pnpm run build
    pnpm --filter=@oplayer/<package_name> run start
    pnpm run dev:exam
  3. Make your changes...

  4. Write some test(s).

  5. Check that everything is ok.

  6. Commit your changes

    git add .
    git commit -m "feat: my amazing feature"
  7. 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