create-easy-ui5 1.0.1 → 1.1.0

package/README.md

@@ -1,56 +1,97 @@
-# npm-init wrapper for Easy-UI5
+# `create-easy-ui5`
 
-[![License Status][license-image]][license-url]
+[![npm version](https://img.shields.io/npm/v/create-easy-ui5.svg)](https://www.npmjs.com/package/create-easy-ui5)
+[![License Status](https://img.shields.io/github/license/ui5-community/create-easy-ui5.svg)](https://github.com/ui5-community/create-easy-ui5/blob/main/LICENSE)
+[![REUSE status](https://api.reuse.software/badge/github.com/ui5-community/create-easy-ui5)](https://api.reuse.software/info/github.com/ui5-community/create-easy-ui5)
 
-This NPM package wraps [Easy-UI5](https://github.com/SAP/generator-easy-ui5) Yeoman generator in [`npm-init`](https://docs.npmjs.com/cli/v8/commands/npm-init), [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) or even just a binary. It automatically benefits from all the available [UI5 Community generators](https://github.com/ui5-community/?q=generator-ui5&type=all&language=&sort=).
+> `npm-init` wrapper for the [Easy-UI5](https://github.com/SAP/generator-easy-ui5) Yeoman generator.
 
-## Getting Started
+`create-easy-ui5` is a thin wrapper that makes the Easy-UI5 generator available
+through `npm init`, `npx`, and a standalone `easy-ui5` binary — so you can
+scaffold a new UI5 project without installing Yeoman or the generator globally
+first. It automatically picks up all available
+[UI5 Community generators](https://github.com/ui5-community/?q=generator-ui5&type=all&language=&sort=).
 
-This NPM packages just adds a few more options to use the Easy-UI5 Yeoman generator - but even a bit easier...
+## Quick Start
 
-### Option 1: Using `npm-init`
-
-The [`npm-init`](https://docs.npmjs.com/cli/v8/commands/npm-init) command is used to setup new repositories. You can use the `create-easy-ui5` package for `npm-init` like this:
+You can use any of the three entry points below — they all do the same thing.
+Pick whichever fits your workflow.
 
 ```sh
+# 1. via npm init (no install required)
 npm init easy-ui5 [template]
+
+# 2. via npx (no install required)
+npx create-easy-ui5 [template]
+
+# 3. via the installed binary
+npm install -g create-easy-ui5
+easy-ui5 [template]
 ```
 
-The `create-easy-ui5` package doesn't need to be installed upfront to be used as `npm-init` is downloading it automatically from the central NPM registry.
+If you omit `[template]`, Easy-UI5 will prompt you to pick one interactively.
 
-### Option 2: Using `npx`
+## Requirements
 
-The [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) command is used to run NPM packages directly and can be used to run the setup script:
+- **Node.js ≥ 20.17** (LTS). See [DEPENDENCIES.md](DEPENDENCIES.md) for the
+  rationale behind this floor.
 
-```sh
-npx create-easy-ui5 [template]
-```
+## How it works
 
-The `create-easy-ui5` package doesn't need to be installed upfront to be used as `npm-init` is downloading it automatically from the central NPM registry.
+`create-easy-ui5` does three things on every invocation:
 
-### Option 3: Using `easy-ui5` binary
+1. Creates a fresh Yeoman environment in the current working directory.
+2. Looks up the `easy-ui5:app` generator from `generator-easy-ui5` (or any
+   compatible generator already installed locally / globally).
+3. Hands control over to that generator, forwarding any CLI arguments you
+   passed in.
 
-The `easy-ui5` binary is provided by the `create-easy-ui5` NPM package and once installed it can be used to setup new repositories using the Easy-UI5 Yeoman generator:
+That's it — the actual project scaffolding, prompts, and template logic all
+live in [`generator-easy-ui5`](https://github.com/SAP/generator-easy-ui5) and
+the [UI5 Community generators](https://github.com/ui5-community/?q=generator-ui5).
+If you hit something that looks like a template bug, please report it there.
 
-```sh
-# Install create-easy-ui5
-npm i -g create-easy-ui5
+## Documentation & Templates
 
-# Run the binary
-easy-ui5 [template]
-```
+- [Easy-UI5 generator](https://github.com/SAP/generator-easy-ui5) — the
+  upstream Yeoman generator this wrapper drives.
+- [UI5 Community generators](https://github.com/ui5-community/?q=generator-ui5&type=all&language=&sort=)
+  — a catalogue of available `[template]` values.
+- [SAPUI5/OpenUI5 documentation](https://sdk.openui5.org/) — UI5 framework
+  reference.
 
 ## Support
 
-Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.
+This project is community-maintained. The best places to get help are:
+
+- 🐛 **Bug reports & feature requests:** the [issue tracker](https://github.com/ui5-community/create-easy-ui5/issues).
+- 💬 **General UI5 questions:** the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/) or [Stack Overflow](https://stackoverflow.com/questions/tagged/ui5).
+
+Please read the [issue reporting guidelines](CONTRIBUTING.md#-reporting-issues)
+before opening an issue.
 
 ## Contributing
 
-We welcome any type of contribution (code contributions, pull requests, issues) to this generator equally.
+Contributions of any kind — bug reports, fixes, doc improvements, ideas —
+are warmly welcomed.
 
-## License
+- [CONTRIBUTING.md](CONTRIBUTING.md) — how to set up, what we expect from
+  pull requests, commit message rules, and the changeset-based release flow.
+- [DEPENDENCIES.md](DEPENDENCIES.md) — why some dependencies are pinned;
+  consult this before bumping anything.
+- [SECURITY.md](SECURITY.md) — how to report vulnerabilities and the
+  supply-chain controls in place on this repository.
+- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) — the Contributor Covenant we
+  follow.
+
+## Release Process
 
-This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.
+This repository uses [Changesets](https://github.com/changesets/changesets)
+for versioning and automated publishing to npm. See the
+[Releasing the Package](CONTRIBUTING.md#-releasing-the-package) section in
+the contributor guide.
+
+## License
 
-[license-image]: https://img.shields.io/github/license/ui5-community/create-easy-ui5.svg
-[license-url]: https://github.com/ui5-community/create-easy-ui5/blob/main/LICENSE
+This project is licensed under the [Apache Software License, Version 2.0](LICENSE),
+except as noted otherwise in the LICENSE file.

package/index.js

@@ -8,27 +8,30 @@ if (args[0] === "easy-ui5") {
 
 // create the env for the plugin generator
 const yeoman = require("yeoman-environment");
-const env = yeoman.createEnv(args, {
-  cwd: process.cwd(),
-});
 
-// lookup the easy-ui5 generator
-const generators = env
-  .lookup({
+(async () => {
+  const env = yeoman.createEnv(args, {
+    cwd: process.cwd(),
+  });
+
+  // lookup the easy-ui5 generator
+  const allGenerators = await env.lookup({
     localOnly: false,
-  })
-  .filter((sub) => {
-    return sub.namespace === "easy-ui5:app";
   });
 
-// finally, run the subgenerator
-if (generators[0]?.namespace) {
-  env.run([generators[0].namespace].concat(args), {
-    // verbose: this.options.verbose,
-    embedded: true,
+  const generators = allGenerators.filter((sub) => {
+    return sub.namespace === "easy-ui5:app";
   });
-} else {
-  console.error(
-    "Easy-UI5 cannot be found! Please run 'npm i -g generator-easy-ui5'!",
-  );
-}
+
+  // finally, run the subgenerator
+  if (generators[0]?.namespace) {
+    await env.run([generators[0].namespace].concat(args), {
+      // verbose: this.options.verbose,
+      embedded: true,
+    });
+  } else {
+    console.error(
+      "Easy-UI5 cannot be found! Please run 'npm i -g generator-easy-ui5'!",
+    );
+  }
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-easy-ui5",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "npm-init wrapper for Easy-UI5",
   "bin": {
     "easy-ui5": "index.js"
@@ -17,28 +17,34 @@
   },
   "homepage": "https://github.com/ui5-community/create-easy-ui5#readme",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.17.0"
   },
+  "files": [
+    "index.js"
+  ],
   "scripts": {
     "start": "node index.js",
     "format": "prettier --write .",
-    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
     "prepare": "node ./.husky/skip.js || husky",
     "hooks:pre-commit": "lint-staged",
     "hooks:commit-msg": "commitlint -e",
-    "preversion": "npm run changelog && git add CHANGELOG.md"
+    "changeset": "changeset",
+    "changeset:empty": "changeset --empty",
+    "version-package": "changeset version && npm install --package-lock-only",
+    "release-publish": "changeset publish"
   },
   "dependencies": {
     "generator-easy-ui5": "^3.9.1"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.7.0",
+    "@changesets/cli": "^2.31.0",
     "@commitlint/cli": "20.2.0",
     "@commitlint/config-conventional": "20.2.0",
-    "conventional-changelog-cli": "^5.0.0",
     "cz-conventional-changelog": "3.3.0",
     "husky": "^9.1.7",
-    "lint-staged": "16.2.7",
-    "prettier": "^3.7.4"
+    "lint-staged": "16.4.0",
+    "prettier": "^3.8.4"
   },
   "lint-staged": {
     "*.{ts,js,json,md,yml}": [

package/.editorconfig

@@ -1,21 +0,0 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-
-root = true
-
-[*]
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-indent_style = space
-
-[*.md]
-trim_trailing_whitespace = false
-
-[{package.json,ui5.yaml}]
-indent_size = 2
-
-[*.js]
-indent_size = 2

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,40 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ""
-labels: ""
-assignees: ""
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
-
-- OS: [e.g. iOS]
-- Browser [e.g. chrome, safari]
-- Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
-
-- Device: [e.g. iPhone6]
-- OS: [e.g. iOS8.1]
-- Browser [e.g. stock browser, safari]
-- Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/custom.md

@@ -1,7 +0,0 @@
----
-name: Custom issue template
-about: Describe this issue template's purpose here.
-title: ""
-labels: ""
-assignees: ""
----

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,19 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ""
-labels: ""
-assignees: ""
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/commitlint.yml

@@ -1,20 +0,0 @@
-name: Lint Commit Message
-on:
-  # Trigger the workflow on push or pull request,
-  # but only for the main branch
-  # See: https://github.community/t/duplicate-checks-on-push-and-pull-request-simultaneous-event/18012
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  commitlint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v4

package/.github/workflows/publish.yml

@@ -1,57 +0,0 @@
-name: Publish
-
-# Trigger on tag push AND manual trigger
-on:
-  push:
-    tags:
-      - "v*.*.*"
-  workflow_dispatch: # Manual trigger
-
-env:
-  HUSKY_SKIP: true
-
-permissions:
-  contents: read
-  id-token: write # REQUIRED for trusted publishing (OIDC)
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          cache: "npm"
-          registry-url: "https://registry.npmjs.org/"
-
-      - name: Read package name
-        id: pkg
-        run: |
-          echo "NAME=$(jq -r '.name' package.json)" >> $GITHUB_ENV
-
-      - name: Decide publish method
-        run: |
-          if npm view "$NAME" > /dev/null 2>&1; then
-            echo "EXISTS=true" >> $GITHUB_ENV
-            echo "Package exists → using trusted publishing"
-          else
-            echo "EXISTS=false" >> $GITHUB_ENV
-            echo "Package does not exist → bootstrap publish"
-          fi
-
-      - name: Publish
-        env:
-          NPM_BOOTSTRAP_TOKEN: ${{ secrets.NPM_BOOTSTRAP_TOKEN }}
-        run: |
-          if [ "$EXISTS" = "false" ]; then
-            echo "//registry.npmjs.org/:_authToken=${NPM_BOOTSTRAP_TOKEN}" > ~/.npmrc
-          fi
-
-          npm publish --access public
-
-          if [ "$EXISTS" = "false" ]; then
-            rm ~/.npmrc
-          fi

package/.husky/commit-msg

@@ -1 +0,0 @@
-npm run hooks:commit-msg

package/.husky/pre-commit

@@ -1 +0,0 @@
-npm run hooks:pre-commit

package/.husky/skip.js

@@ -1,6 +0,0 @@
-/* eslint-disable */
-if (process.env.HUSKY_SKIP || process.env.NODE_ENV === "production") {
-  process.exit(0);
-} else {
-  process.exit(1);
-}

package/.prettierignore

@@ -1 +0,0 @@
-package-lock.json

package/CHANGELOG.md

@@ -1,11 +0,0 @@
-## 1.0.0 (2025-12-29)
-
-- build: update changelog ([6b951e1](https://github.com/ui5-community/create-easy-ui5/commit/6b951e1))
-- build: update depenendencies ([5696b04](https://github.com/ui5-community/create-easy-ui5/commit/5696b04))
-- 1.0.0 ([aeec02c](https://github.com/ui5-community/create-easy-ui5/commit/aeec02c))
-- 1.0.1 ([dc5c80d](https://github.com/ui5-community/create-easy-ui5/commit/dc5c80d))
-- Initial commit ([eb18673](https://github.com/ui5-community/create-easy-ui5/commit/eb18673))
-- chore: update release process ([8e233af](https://github.com/ui5-community/create-easy-ui5/commit/8e233af))
-- fix: bugfix for arguments and polish docs ([29577d1](https://github.com/ui5-community/create-easy-ui5/commit/29577d1))
-- fix: run easy-ui5 in embedded mode ([f9e8178](https://github.com/ui5-community/create-easy-ui5/commit/f9e8178))
-- feat: fully initalize the repo ([532fc33](https://github.com/ui5-community/create-easy-ui5/commit/532fc33))

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-ui5communityteam@gmail.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,166 +0,0 @@
-# Contributing to `create-easy-ui5`
-
-## Content
-
-1. [📝 **Reporting Issues**](#-reporting-issues)
-2. [🤩 **Feature Requests**](#-feature-requests)
-3. [🔍 **Analyzing Issues**](#-analyzing-issues)
-4. [💻 **Contributing Code**](#-contributing-code)
-5. [📦 **Releasing Package**](#-releasing-package)
-
-## 📝 Reporting Issues
-
-### Seeking Help / Not a Bug
-
-If you need help setting something up, or if you have questions regarding `create-easy-ui5`, please seek help on a community platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
-
-### How to Report an Issue
-
-1. **Only `create-easy-ui5` issues**
-2. **No duplicate**: You have searched the [issue tracker](https://github.com/ui5-community/create-easy-ui5/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to make sure the bug has not already been reported.
-3. **Good summary**: The summary should be specific to the issue.
-4. **Current bug**: The bug can be reproduced in the most current version of the relevant module(s).
-5. **Reproducible bug**: There are step-by-step instructions provided on how to reproduce the issue.
-6. **Well-documented**:
-   - Precisely state the expected and the actual behavior.
-   - Give information about the environment in which the issue occurs (OS/Platform, Node.js version, etc.).
-   - Generally, give as much additional information as possible.
-7. **Only one bug per report**: Open additional tickets for additional issues.
-8. **Please report bugs in English.**
-
-We encourage you to follow the issue template that will be presented to you when creating a new issue.
-
-When you are ready, report your issue here: https://github.com/ui5-community/create-easy-ui5/issues/new
-
-### Use of Labels
-
-GitHub offers labels to categorize issues. The labels can only be set and modified by committers.
-
-#### General issue categories
-
-- **`bug`**: This issue is a bug in the code.
-- **`documentation`**: This issue is about wrong documentation.
-- **`enhancement`**: This is not a bug report, but an enhancement request.
-
-#### Status of an open issue
-
-- **`information required`**: The author is required to provide information.
-- **`good first issue`**: A newcomer may work on this.
-- **`help wanted`**: Additional help in analyzing this issue is required.
-
-#### Status/resolution of a closed issue
-
-- **`duplicate`**: The issue was already reported somewhere else.
-- **`invalid`**: For any reason, this issue report will not be handled further. Possible reasons are lack of information, or that the issue does not apply anymore.
-- **`wontfix`**: While acknowledged to be an issue, a fix cannot or will not be provided.
-
-### Issue Reporting Disclaimer
-
-We want to improve the quality of the UI5 Communtiy projects and good bug reports are welcome! But keep in mind that this here is spare-time work and thus the capacity is limited.
-
-Therefore, we reserve the right to close or to not process insufficient bug reports in favor of those which are clearly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it won't happen - please remember: The UI5 Community projects are Open Source and comes without warranty.
-
-Bug report analysis support is always very welcome! See [Analyze Issues](#-analyzing-issues).
-
-## 🤩 Feature Requests
-
-You can request most features by creating an issue in the repository: https://github.com/ui5-community/create-easy-ui5/issues/new
-
-## 🔍 Analyzing Issues
-
-Analyzing issue reports can be a lot of effort. Any help is welcome! 👍
-
-You may be able to add additional or missing information, such as a step-by-step guide on how to reproduce an issue or an analysis of the root cause. In case of the latter, you might even be able to [contribute](#-contributing-code) a bugfix. 🙌
-
-## 💻 Contributing Code
-
-### General Remarks
-
-You are welcome to contribute code to the project in order to fix bugs or to implement new features.
-
-There are three important things to know:
-
-1. You must be aware of the Apache License (which describes contributions).
-2. **Not all proposed contributions can be accepted**. Some features may just fit a third-party add-on better. The code must match the overall direction of the project and improve it. Before contributing a feature, please open a feature request upfront to discuss the necessity of the feature with the core contributors.
-
-### How to Contribute
-
-1. Make sure the change is welcome (see [General Remarks](#general-remarks)).
-2. Create a branch by forking the relevant module repository and apply your change.
-3. Commit and push your change on that branch.
-4. Create a pull request in the relevant repository.
-5. Wait for our code review and approval, possibly enhancing your change on request.
-6. Once the change has been approved and merged, we will inform you in a comment.
-7. Let's celebrate together! 🎉
-
-#### Requirements
-
-The technical requirements to contribute to the project are the following:
-
-- A current version of [Node.js](https://nodejs.org/)
-- A code editor (preferably the free [Microsoft Visual Studio Code](https://code.visualstudio.com/))
-
-#### Getting Started
-
-To get started contributing to this project you need to do the following steps:
-
-- Clone the repository
-- Run `npm install`
-
-#### Commit Messages format
-
-This project enforces the [conventional-commits][conventional_commits] commit message formats.
-The possible commits types prefixes are limited to those defined by [conventional-commit-types][commit_types].
-This promotes a clean project history and enabled automatically generating a changelog.
-
-The commit message format will be inspected both on a git pre-commit hook
-and during the central CI build and will **fail the build** if issues are found.
-
-#### Formatting
-
-[Prettier](https://prettier.io/) is used for some of the sub-packages to do a proper code formatting. The formatting is running as part of the `pre-commit` hook.
-
-#### Compiling
-
-This project is implemented using plain ECMAScript without any compilation / transpilation steps.
-
-#### Testing
-
-There is no testing tooling used for this repository so for. To test the project the simplest way is to run it:
-
-```sh
-# run the project
-npm start
-```
-
-## 📦 Release Package
-
-This repository uses [Lerna](https://github.com/lerna/lerna) to manage the release process.
-
-### Release Process
-
-First, make sure that you pull the latest state of the GitHub repository and then proceed with the following steps:
-
-1. Update the version: `npm version patch|minor|major`
-2. Update the changelog: `npm run changelog`, commit and amend the version change from step 1: `git add . && git commit --amend --no-edit`
-3. Push the new commit and tag: `git push origin --tags`
-4. Inspect the newly artifacts published on npmjs.com.
-
-A GitHub action will do the needful once the new tag has been pushed.
-
-### Upgrading the version of the dependencies
-
-To upgrade the version of the dependencies the NPM package `npm-check-updates` is used. The following code snippets shows how to use it:
-
-```bash
-# install the npm-check-updates
-npm install -g npm-check-updates
-
-# check for dependencies to be updated
-ncu
-
-# update the dependencies automatically
-ncu -u
-```
-
-Be careful with major version changes of the dependencies as this might cause additional work to make the package running again.