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: docs/Guidelines.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# Development Conventions and Guidelines
2
2
## Local Development Environment
3
-
You can use any IDE or text editor of your choice. There are no specific requirements or additions for a certain IDE.
3
+
You can use any IDE or text editor of your choice. There are no specific requirements or additions for a particular IDE.
4
4
5
5
### Prerequisites
6
6
7
-
-[Node.js](https://nodejs.org/) (See `engines` section in [package.json](../package.json) for the required version)
8
-
-[npm](https://www.npmjs.com/) (comes with Node.js)
7
+
-[Node.js](https://nodejs.org/): See the `engines` section in [package.json](../package.json) for the required version.
8
+
-[npm](https://www.npmjs.com/): This comes with Node.js.
9
9
10
-
UI5 CLI is tested on Windows, macOS, and Linux. However, some tools and scripts require a Unix-like shell environment, so we recommend using [Git Bash](https://git-scm.com/install/windows) on Windows.
10
+
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.
11
11
12
12
### Installation
13
13
@@ -20,7 +20,7 @@ UI5 CLI is tested on Windows, macOS, and Linux. However, some tools and scripts
20
20
```sh
21
21
npm install
22
22
```
23
-
3.*(Optional)* If you want to test the CLI locally, you can link the package to make the `ui5` command available globally:
23
+
3.*(Optional)* If you want to test the CLI locally, link the package to make the `ui5` command available globally:
24
24
```sh
25
25
npm link --workspace @ui5/cli
26
26
```
@@ -30,7 +30,7 @@ UI5 CLI is tested on Windows, macOS, and Linux. However, some tools and scripts
30
30
```sh
31
31
npm uninstall --global @ui5/cli
32
32
```
33
-
If you had previously installed UI5 CLI globally using `npm install --global @ui5/cli`, you need to re-install it after removing the link.
33
+
If you remove the link and previously installed UI5 CLI globally using `npm install --global @ui5/cli`, you need to re-install it.
34
34
35
35
## JavaScript Coding Guidelines
36
36
We enforce code style rules using [ESLint](https://eslint.org). Execute `npm run lint` to check your code for style issues.
0 commit comments