Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 1.41 KB

Rstest contributing guide

Thanks for that you are interested in contributing to Rstest. Before starting your contribution, please take a moment to read the following guidelines.

Install Node.js

Use fnm or nvm to run the command below. This will switch to the Node.js version specified in the project's .nvmrc file.

# with fnm
fnm use

# with nvm
nvm use

Install dependencies

Enable pnpm with corepack:

corepack enable

Install dependencies:

pnpm install

What this will do:

  • Install all dependencies.
  • Create symlinks between packages in the monorepo
  • Run the prepare script to build all packages, powered by nx.

Making changes and building

Once you have set up the local development environment in your forked repository, we can start development.

Checkout a new branch

It is recommended to develop on a new branch, as it will make things easier later when you submit a pull request:

git checkout -b MY_BRANCH_NAME

Build the package

Use nx build to build the package you want to change:

npx nx build @rstest/core

Build all packages:

pnpm run build

You can also use the watch mode to automatically rebuild the package when you make changes:

npx nx build @rstest/core --watch