diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc0adaf6..c22e64c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,36 @@ Please try to use the original style in the codebase. Do not introduce new rules Nue is not using Prettier or ESLint because they will increase the project size to 40MB. The `.prettierrc.yaml` file on the root directory does the job well enough. - - - +### Testing + +```sh +# if using bun +bun install +bun test + +# if using node +npm install +npm install --global jest +node --experimental-vm-modules $(which jest) +``` + + +### Linking + +```sh +# if using bun +bun install +cd packages/nuekit +bun link +cd my/nue/project +nue +nue build --production + +# if using node +npm install +cd packages/nuekit +npm link +cd my/nue/project +node $(which nue) +node $(which nue) build --production +```