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: CONTRIBUTING.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to the UI5 Tooling
1
+
# Contributing to the UI5 CLI
2
2
## Content
3
3
1.[📝 **Reporting Issues**](#-reporting-issues)
4
4
2.[🤩 **Feature Requests**](#-feature-requests)
@@ -11,12 +11,12 @@
11
11
12
12
## 📝 Reporting Issues
13
13
### Seeking Help / Not a Bug
14
-
If you need help setting something up, or if you have questions regarding UI5 Tooling, please seek help on a community platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com).
14
+
If you need help setting something up, or if you have questions regarding UI5 CLI, please seek help on a community platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com).
15
15
16
16
### How to Report an Issue
17
-
Note that we collect issues for all UI5 Tooling modules (*[ui5-cli](https://github.com/SAP/ui5-cli), [ui5-server](https://github.com/SAP/ui5-server), [ui5-project](https://github.com/SAP/ui5-project), [ui5-builder](https://github.com/SAP/ui5-builder), [ui5-fs](https://github.com/SAP/ui5-fs) and [ui5-logger](https://github.com/SAP/ui5-logger)*) in the central [ui5-tooling](https://github.com/SAP/ui5-tooling) repository.
17
+
Note that we collect issues for all UI5 CLI modules (*[ui5-cli](https://github.com/SAP/ui5-cli), [ui5-server](https://github.com/SAP/ui5-server), [ui5-project](https://github.com/SAP/ui5-project), [ui5-builder](https://github.com/SAP/ui5-builder), [ui5-fs](https://github.com/SAP/ui5-fs) and [ui5-logger](https://github.com/SAP/ui5-logger)*) in the central [ui5-tooling](https://github.com/SAP/ui5-tooling) repository.
18
18
19
-
1.**Only UI5 Tooling issues**
19
+
1.**Only UI5 CLI issues**
20
20
* Please do not report:
21
21
* Issues caused by dependencies or plugins.
22
22
* Issues caused by the use of non-public/internal methods. Only the public methods listed in the API documentation may be used.
@@ -54,7 +54,7 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi
54
54
-**`Bug`**: This issue is a bug in the code.
55
55
-**`Feature`**: This is not a bug report, but an feature request.
56
56
57
-
#### Specific issue categories for UI5 Tooling:
57
+
#### Specific issue categories for UI5 CLI:
58
58
***`documentation`**: This issue is about wrong documentation.
59
59
***`needs triage`**: This issue needs to be investigated and confirmed as a valid issue that is not a duplicate
60
60
***`module/ui5-builder`**: This issue is related to the UI5 Builder module
@@ -75,14 +75,14 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi
75
75
***`wontfix`**: While acknowledged to be an issue, a fix cannot or will not be provided.
76
76
77
77
### Issue Reporting Disclaimer
78
-
We want to improve the quality of the UI5 Tooling and good bug reports are welcome! But our capacity is limited, so we cannot handle questions or consultation requests, and we cannot afford to ask for required details.
78
+
We want to improve the quality of the UI5 CLI and good bug reports are welcome! But our capacity is limited, so we cannot handle questions or consultation requests, and we cannot afford to ask for required details.
79
79
80
-
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 Tooling is Open Source and comes without warranty.
80
+
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 CLI is Open Source and comes without warranty.
81
81
82
82
Bug report analysis support is always very welcome! See [Analyze Issues](#-analyzing-issues).
83
83
84
84
## 🤩 Feature Requests
85
-
You can request most features by creating an issue in the UI5 Tooling repository: https://github.com/SAP/ui5-tooling/issues/new
85
+
You can request most features by creating an issue in the UI5 CLI repository: https://github.com/SAP/ui5-tooling/issues/new
86
86
87
87
For bigger features an RFC (Request for Comment) might be necessary. You should always clarify the need for an RFC with the project contributors upfront. You could do this either by opening an issue or in our [Slack channel](#seeking-help--not-a-bug). You can use [this template](rfcs/0000-template.md) for creating an RFC.
88
88
@@ -96,13 +96,13 @@ You may be able to add additional or missing information, such as a step-by-step
96
96
97
97
## 💻 Contributing Code
98
98
### General Remarks
99
-
You are welcome to contribute code to the UI5 Tooling in order to fix bugs or to implement new features.
99
+
You are welcome to contribute code to the UI5 CLI in order to fix bugs or to implement new features.
100
100
101
101
There are three important things to know:
102
102
103
103
1. You must be aware of the Apache License (which describes contributions) and **agree to the Developer Certificate of Origin***. This is common practice in major Open Source projects. To make this process as simple as possible, we are using *[CLA assistant](https://cla-assistant.io/)* for individual contributions. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click experience for accepting the DCO. For company contributers, special rules apply. See the respective section below for details.
104
104
2. Follow our **[Development Conventions and Guidelines](docs/Guidelines.md)**.
105
-
3.**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 UI5 Tooling and improve it. So there should be some "bang for the byte". For most bug fixes this is a given, but a major feature implementation first needs to be discussed with one of the committers. Possibly, one who touched the related code or module recently. The more effort you invest, the better you should clarify in advance whether the contribution will match the project's direction. The best way would be to just open an enhancement ticket in the issue tracker to discuss the feature you plan to implement (make it clear that you intend to contribute). We will then forward the proposal to the respective code owner. This avoids disappointment.
105
+
3.**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 UI5 CLI and improve it. So there should be some "bang for the byte". For most bug fixes this is a given, but a major feature implementation first needs to be discussed with one of the committers. Possibly, one who touched the related code or module recently. The more effort you invest, the better you should clarify in advance whether the contribution will match the project's direction. The best way would be to just open an enhancement ticket in the issue tracker to discuss the feature you plan to implement (make it clear that you intend to contribute). We will then forward the proposal to the respective code owner. This avoids disappointment.
106
106
107
107
### Developer Certificate of Origin (DCO)
108
108
@@ -113,7 +113,7 @@ This DCO replaces the previously used CLA ("Contributor License Agreement") as w
113
113
114
114
### How to Contribute
115
115
1. Make sure the change is welcome (see [General Remarks](#general-remarks)).
116
-
- Also check on the [UI5 Tooling Task Board](https://github.com/orgs/SAP/projects/1) whether related tasks are already being worked on, blocked, or in discussion.
116
+
- Also check on the [UI5 CLI Task Board](https://github.com/orgs/SAP/projects/1) whether related tasks are already being worked on, blocked, or in discussion.
117
117
1. Create a branch by forking the relevant module repository and apply your change.
118
118
1. Commit and push your change on that branch.
119
119
- 👉 **Please follow our [Development Conventions and Guidelines](docs/Guidelines.md).**
@@ -125,7 +125,7 @@ This DCO replaces the previously used CLA ("Contributor License Agreement") as w
125
125
1. Celebrate! 🎉
126
126
127
127
### Multi-Branch Development
128
-
There are phases when development of a new major version of UI5 Tooling has already started, but this new major version hasn't been released yet. This situation requires a special handling of pull requests / commits if the actual coding change should be both part of the current (e.g. Version 3) and the new major version (e.g. Version 4).
128
+
There are phases when development of a new major version of UI5 CLI has already started, but this new major version hasn't been released yet. This situation requires a special handling of pull requests / commits if the actual coding change should be both part of the current (e.g. Version 3) and the new major version (e.g. Version 4).
129
129
130
130
1. Create a pull request for the current version (e.g. Version 3) with the desired commit message header `[FEATURE]`, `[FIX]` or `[INTERNAL]`.
131
131
2. Rebase and merge the PR in the current version.
[](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com)
Copy file name to clipboardExpand all lines: docs/index.md
+13-8Lines changed: 13 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,18 @@
1
1

2
2
3
-
# UI5 Tooling
3
+
# UI5 CLI
4
4
5
5
An open and modular toolchain to develop state-of-the-art applications based on the [UI5](https://ui5.sap.com) framework.
6
6
7
+
!!! abstract "Project Rename"
8
+
**UI5 Tooling has been renamed to UI5 CLI 🚨**
9
+
10
+
Read the announcement blog post: **[SAP Community: Goodbye UI5 Tooling - Hello UI5 CLI!](https://community.sap.com/t5/technology-blog-posts-by-sap/goodbye-ui5-tooling-hello-ui5-cli/ba-p/14211769)**
11
+
7
12
!!! tip "New Release"
8
-
**UI5 Tooling V4 is here 🎉**
13
+
**UI5 CLI V4 is here 🎉**
9
14
10
-
Read the announcement blog post: **[SAP Community: UI5 Tooling 4.0](https://community.sap.com/t5/technology-blogs-by-sap/ui5-tooling-4-0/ba-p/13769578)**
15
+
Read the announcement blog post: **[SAP Community: UI5 CLI 4.0](https://community.sap.com/t5/technology-blogs-by-sap/ui5-tooling-4-0/ba-p/13769578)**
11
16
12
17
And checkout the **[Migrate to v4](./updates/migrate-v4.md)** documentation.
13
18
@@ -29,7 +34,7 @@ npm install --save-dev @ui5/cli
29
34
30
35
#### ⚙️ Project Setup
31
36
32
-
Configure your project for use with UI5 Tooling.
37
+
Configure your project for use with UI5 CLI.
33
38
*Also see the [Configuration Documentation](./pages/Configuration.md)*
34
39
35
40
```
@@ -44,7 +49,7 @@ type: application
44
49
45
50
#### 🚚 Dependency Management
46
51
47
-
UI5 framework dependencies are managed by the tooling. All other dependencies are managed by your favorite node package manager.
52
+
UI5 framework dependencies are managed by UI5 CLI. All other dependencies are managed by your favorite node package manager.
@@ -91,10 +96,10 @@ info ProjectBuilder Executing cleanup tasks...
91
96
92
97
### 🧪 Node.js API
93
98
94
-
Most UI5 Tooling modules provide JavaScript APIs for direct consumption in other Node.js projects.
95
-
This allows you to rely on UI5 Tooling for UI5-specific build functionality and project handling, while creating your own tools to perfectly match the needs of your project.
99
+
Most UI5 CLI modules provide JavaScript APIs for direct consumption in other Node.js projects.
100
+
This allows you to rely on UI5 CLI for UI5-specific build functionality and project handling, while creating your own tools to perfectly match the needs of your project.
96
101
97
-
All available APIs are documented in the [UI5 Tooling API Reference](https://sap.github.io/ui5-tooling/v4/api/index.html).
102
+
All available APIs are documented in the [UI5 CLI API Reference](https://sap.github.io/ui5-tooling/v4/api/index.html).
Copy file name to clipboardExpand all lines: docs/indexJsdoc.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# UI5 Tooling API Reference
1
+
# UI5 CLI API Reference
2
2
3
3
## Support
4
4
Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue. Or chat with us in the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com)
0 commit comments