You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/community/contributing/proposing-enhancements.mdx
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -29,12 +29,12 @@ This virtual workspace is free of charge thanks to the [generous free tier](http
29
29
Alternatively, if you prefer to work on the pull request on your own machine instead of using Gitpod, you'll need to:
30
30
31
31
-[Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) your fork to your machine
32
-
-Make sure you have the [runtime dependencies](/handbook/getting-started/installation/) installed
33
-
-Install the Node.js dependencies by running `make install` in the project root. Serenity/JS uses [Lerna.js](https://github.com/lerna/lerna)to manage the `@serenity-js/*` modules you'll find in the mono-repo, so it will take care of propagating the `npm ci` and other commands to the modules (this step happens automatically in the Gitpod workspace)
34
-
-Make sure you can build the Serenity/JS project on your machine and all the unit- and integration tests are passing before introducing any changes by running `make clean test` to run the package-scope tests or `make clean verify` to run package-scope and integration tests.
32
+
-Install the [runtime dependencies](/handbook/getting-started/installation/): Node.js LTS and Java Runtime Environment
33
+
-Run `make install` in the project root to install the Node.js dependencies. Serenity/JS uses [Lerna.js](https://github.com/lerna/lerna), [PnPm](https://pnpm.io/) and [Node.js Corepack](https://github.com/nodejs/corepack)to manage the `@serenity-js/*` modules in the mono-repo, `make install` installs all three for you. Note that this step happens automatically in the Gitpod workspace.
34
+
-Run `make clean test` to make sure you can build the Serenity/JS project on your machine and all the unittests are passing before introducing any changes.
35
35
- Introduce the changes you wish to propose and update or introduce any package-scope and integration tests that are relevant.
36
-
-Run **full local build** before committing - `make clean verify report`
37
-
-Commit your changes following the [Serenity/JS conventional commits standard](/community/contributing/commit-message-conventions/), push them to your forked repository, and raise a pull request - more on commit message standard and automated releases below.
36
+
-Commit your changes following the [Serenity/JS conventional commits standard](/community/contributing/commit-message-conventions/), push them to your forked repository, and raise a pull request.
37
+
-Run **full local build** - `make clean verify report` before raising a pull request
38
38
39
39
### Serenity/JS mono-repo structure
40
40
@@ -56,7 +56,7 @@ Here's a list of commands you'll need to build and test Serenity/JS locally:
56
56
-`make test` - executes the unit tests located under `packages/*/spec`
57
57
-`make integration-test` - executes the integration tests located under `integration/*/spec`,
58
58
-`make verify` - runs ESLint, transpiles TypeScript to JavaScript, runs the unit tests and other package-scope tests, runs the integration tests located under `integration/*/`
59
-
-`make verify report site` - same as verify, but additionally generates aggregated test and coverage reports and produces the serenity-js.org website. This is the **full local build** you should run at least once before committing your changes and submitting the pull request.
59
+
-`make verify report` - same as verify, but additionally generates aggregated test and coverage reports. This is the **full local build** you should run at least once before submitting the pull request.
60
60
61
61
If you encounter any issues, let us know on the [Serenity/JS Community Chat](https://matrix.to/#/#serenity-js:gitter.im).
0 commit comments