diff --git a/docs/Guidelines.md b/docs/Guidelines.md index c798d062907..b6e387a4f41 100644 --- a/docs/Guidelines.md +++ b/docs/Guidelines.md @@ -1,4 +1,37 @@ # Development Conventions and Guidelines +## Local Development Environment +You can use any IDE or text editor of your choice. There are no specific requirements or additions for a particular IDE. + +### Prerequisites + +- [Node.js](https://nodejs.org/): See the `engines` section in [package.json](../package.json) for the required version. +- [npm](https://www.npmjs.com/): This comes with Node.js. + +UI5 CLI is tested on Windows, macOS, and Linux. As some tools and scripts require a Unix-like shell environment, we recommend using [Git Bash](https://git-scm.com/install/windows) on Windows. + +### Installation + +1. Clone the repository and navigate into it: + ```sh + git clone https://github.com/UI5/cli.git + cd cli + ``` +2. Install all dependencies in the repository (npm workspace): + ```sh + npm install + ``` +3. *(Optional)* If you want to test the CLI locally, link the package to make the `ui5` command available globally: + ```sh + npm link --workspace @ui5/cli + ``` + **Note:** You might need to set the environment variable `UI5_CLI_NO_LOCAL` to `X` (or any value) to avoid invoking a local installation of UI5 CLI in your current working directory. + + You can remove the global link using: + ```sh + npm uninstall --global @ui5/cli + ``` + If you remove the link and previously installed UI5 CLI globally using `npm install --global @ui5/cli`, you need to re-install it. + ## JavaScript Coding Guidelines We enforce code style rules using [ESLint](https://eslint.org). Execute `npm run lint` to check your code for style issues. You may also find an ESLint integration for your favorite IDE [here](https://eslint.org/docs/user-guide/integrations). diff --git a/internal/documentation/docs/pages/Benchmarking.md b/internal/documentation/docs/pages/Benchmarking.md index 0df16d45812..c6ad1bbfd4a 100644 --- a/internal/documentation/docs/pages/Benchmarking.md +++ b/internal/documentation/docs/pages/Benchmarking.md @@ -12,17 +12,17 @@ The following is a walk-through on how to evaluate the performance impact of cha 2. Prepare the UI5 CLI repository *(optional if your development environment already reflects this)*: 1. Clone [UI5 CLI](https://github.com/UI5/cli) (or your fork) and navigate into it ```sh - git clone git@github.com:UI5/cli.git + git clone https://github.com/UI5/cli.git cd cli ``` Make sure you check out the `main` branch, since we'll perform the baseline test first - 2. Install npm dependencies + 2. Install all dependencies in the repository (npm workspace): ```sh npm install ``` - 3. Create a global npm link for `@ui5/cli` + 3. Link the `@ui5/cli` package to make the `ui5` command available globally ```sh - (cd packages/cli && npm link) + npm link --workspace @ui5/cli ``` 4. Verify your setup ```sh