Skip to content

Commit 50483c7

Browse files
matz3KlattG
andauthored
docs: Apply suggestions from code review
Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>
1 parent 8458415 commit 50483c7

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/Guidelines.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Development Conventions and Guidelines
22
## 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.
44

55
### Prerequisites
66

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.
99

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.
1111

1212
### Installation
1313

@@ -20,7 +20,7 @@ UI5 CLI is tested on Windows, macOS, and Linux. However, some tools and scripts
2020
```sh
2121
npm install
2222
```
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:
2424
```sh
2525
npm link --workspace @ui5/cli
2626
```
@@ -30,7 +30,7 @@ UI5 CLI is tested on Windows, macOS, and Linux. However, some tools and scripts
3030
```sh
3131
npm uninstall --global @ui5/cli
3232
```
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.
3434

3535
## JavaScript Coding Guidelines
3636
We enforce code style rules using [ESLint](https://eslint.org). Execute `npm run lint` to check your code for style issues.

0 commit comments

Comments
 (0)