Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 1.13 KB
Raw

Contributing

Development

If you would like to contribute by fixing an open issue or developing a new feature you can use this suggested workflow:

  • First fork the repository,
    • Create a new feature branch off the main branch.
  • Second, install the dependencies of the monorepo:
yarn install
  • Build the library:
cd packages/custoplayer && yarn build
  • Run the development server of the test project:
yarn dev

  • Open http://localhost:3000 with your browser to see the result.

  • Make and commit desired changes.

    • Make sure to run yarn lint --fix before commiting to ensure that there are no linting errors.

  • Finally, submit a pr from your forked branch to the Custoplayer main branch

Testing

If you want to run the unit tests run:

cd packages/custoplayer && yarn cy:open-unit

If you want to run the unit tests headlessly do:

yarn cy:run-unit

If you want to run the end to end tests run:

cd packages/custoplayer && yarn cy:open-e2e

If you want to run the end to end tests headlessly do:

yarn cy:run-e2e