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
+14-14Lines changed: 14 additions & 14 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
3
3
## Content
4
4
@@ -9,23 +9,23 @@
9
9
10
10
### ⚡️ Quick Links for Maintainers
11
11
12
-
-[All Open Pull Requests](https://github.com/SAP/ui5-tooling-extensions/pulls)
13
-
-[All Open Issues](https://github.com/SAP/ui5-tooling-extensions/pulls)
12
+
-[All Open Pull Requests](https://github.com/UI5/cli-extensions/pulls)
13
+
-[All Open Issues](https://github.com/UI5/cli-extensions/pulls)
14
14
15
15
## 📝 Reporting Issues
16
16
17
17
### Seeking Help / Not a Bug
18
18
19
-
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://join.slack.com/t/openui5/shared_invite/zt-1q128gn3p-JeZTi9XCpPxW8kBohSgqnw).
19
+
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-cli) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://join.slack.com/t/openui5/shared_invite/zt-1q128gn3p-JeZTi9XCpPxW8kBohSgqnw).
20
20
21
21
### How to Report an Issue
22
22
23
-
1.**Only UI5 Tooling Extensons issues**
23
+
1.**Only UI5 CLI Extensons issues**
24
24
* Please do not report:
25
25
* Issues caused by dependencies.
26
26
* Issues caused by the use of non-public/internal methods. Only the public methods listed in the API documentation may be used.
27
27
* Something you do not get to work properly, see [Not a Bug / Questions](#not-a-bug--questions).
28
-
2.**No duplicate**: You have searched the [issue tracker](https://github.com/SAP/ui5-tooling-extensions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to make sure the bug has not already been reported.
28
+
2.**No duplicate**: You have searched the [issue tracker](https://github.com/UI5/cli-extensions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to make sure the bug has not already been reported.
29
29
3.**Good summary**: The summary should be specific to the issue.
30
30
4.**Current bug**: The bug can be reproduced in the most current version of the relevant module(s).
31
31
5.**Reproducible bug**: There are step-by-step instructions provided on how to reproduce the issue.
@@ -38,7 +38,7 @@ If you need help setting something up, or if you have questions regarding UI5 To
38
38
39
39
We encourage you to follow the issue template that will be presented to you when creating a new issue.
40
40
41
-
When you are ready, report your issue here: https://github.com/SAP/ui5-tooling-extensions/issues/new
41
+
When you are ready, report your issue here: https://github.com/UI5/cli-extensions/issues/new
42
42
43
43
### Reporting Security Issues
44
44
@@ -60,7 +60,7 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi
60
60
-**`Bug`**: This issue is a bug in the code.
61
61
-**`Feature`**: This is not a bug report, but an feature request.
62
62
63
-
#### Specific issue categories for UI5 Tooling Extensions:
63
+
#### Specific issue categories for UI5 CLI Extensions:
64
64
65
65
-**`documentation`**: This issue is about wrong documentation.
66
66
-**`needs triage`**: This issue needs to be investigated and confirmed as a valid issue that is not a duplicate
@@ -79,15 +79,15 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi
79
79
80
80
### Issue Reporting Disclaimer
81
81
82
-
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.
82
+
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.
83
83
84
-
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.
84
+
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.
85
85
86
86
Bug report analysis support is always very welcome! See [Analyze Issues](#-analyzing-issues).
87
87
88
88
## 🤩 Feature Requests
89
89
90
-
You can request most features by creating an issue in the UI5 Tooling repository: https://github.com/SAP/ui5-tooling-extensions/issues/new
90
+
You can request most features by creating an issue in the UI5 CLI repository: https://github.com/UI5/cli-extensions/issues/new
91
91
92
92
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.
93
93
@@ -104,13 +104,13 @@ You may be able to add additional or missing information, such as a step-by-step
104
104
105
105
### General Remarks
106
106
107
-
You are welcome to contribute code to the UI5 Tooling in order to fix bugs or to implement new features.
107
+
You are welcome to contribute code to the UI5 CLI in order to fix bugs or to implement new features.
108
108
109
109
There are three important things to know:
110
110
111
111
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.
112
112
2. Follow our **[Development Conventions and Guidelines](docs/Guidelines.md)**.
113
-
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.
113
+
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.
114
114
115
115
### Developer Certificate of Origin (DCO)
116
116
@@ -122,7 +122,7 @@ This DCO replaces the previously used CLA ("Contributor License Agreement") as w
122
122
### How to Contribute
123
123
124
124
1. Make sure the change is welcome (see [General Remarks](#general-remarks)).
125
-
- Also check on the [UI5 Tooling Extensions Task Board](https://github.com/orgs/SAP/projects/39) whether related tasks are already being worked on, blocked, or in discussion.
125
+
- Also check on the [UI5 CLI Extensions Task Board](https://github.com/orgs/SAP/projects/39) whether related tasks are already being worked on, blocked, or in discussion.
126
126
1. Create a branch by forking the relevant module repository and apply your change.
127
127
1. Commit and push your change on that branch.
128
128
- 👉 **Please follow our [Development Conventions and Guidelines](docs/Guidelines.md).**
[](https://join.slack.com/t/openui5/shared_invite/zt-1q128gn3p-JeZTi9XCpPxW8kBohSgqnw)
The offered extensions require UI5 Tooling Version 3 and above.
14
+
The offered extensions require UI5 CLI Version 3 and above.
15
15
16
16
## Packages
17
17
18
-
UI5 Tooling Extensions consist of multiple packages managed in a separate folder:
18
+
UI5 CLI Extensions consist of multiple packages managed in a separate folder:
19
19
20
20
-[middleware-code-coverage](packages/middleware-code-coverage/): A custom server middleware providing an endpoint for code instrumentation
21
21
22
-
These extensions are developed and maintained by SAP. There are many more UI5 Tooling extensions available developed by the open-source community. Check out [Best of UI5](https://bestofui5.org/) to explore the world of custom UI5 Tooling middlewares/tasks, UI5 controls and more.
22
+
These extensions are developed and maintained by SAP. There are many more UI5 CLI extensions available developed by the open-source community. Check out [Best of UI5](https://bestofui5.org/) to explore the world of custom UI5 CLI middlewares/tasks, UI5 controls and more.
23
23
24
24
## Code of Conduct
25
25
26
-
Please check our [Code of Conduct](https://github.com/SAP/ui5-tooling-extensions/blob/main/CODE_OF_CONDUCT.md).
26
+
Please check our [Code of Conduct](https://github.com/UI5/cli-extensions/blob/main/CODE_OF_CONDUCT.md).
Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling-extensions/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://join.slack.com/t/openui5/shared_invite/zt-1q128gn3p-JeZTi9XCpPxW8kBohSgqnw). For public Q&A, use the [`ui5-tooling` tag on Stack Overflow](https://stackoverflow.com/questions/tagged/ui5-tooling).
34
+
Please follow our [Contribution Guidelines](https://github.com/UI5/cli-extensions/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://join.slack.com/t/openui5/shared_invite/zt-1q128gn3p-JeZTi9XCpPxW8kBohSgqnw). For public Q&A, use the [`ui5-cli` tag on Stack Overflow](https://stackoverflow.com/questions/tagged/ui5-cli).
35
35
36
36
## Licensing
37
37
38
-
Copyright 2025 SAP SE or an SAP affiliate company and UI5 Tooling Extensions contributors. Please see our [LICENSE.txt](LICENSE.txt) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/ui5-tooling-extensions).
38
+
Copyright 2025 SAP SE or an SAP affiliate company and UI5 CLI Extensions contributors. Please see our [LICENSE.txt](LICENSE.txt) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/UI5/cli-extensions).
SPDX-PackageComment = "The code in this project may include calls to APIs (“API Calls”) of\n SAP or third-party products or services developed outside of this project\n (“External Products”).\n “APIs” means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project’s code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
6
6
7
7
[[annotations]]
8
8
path = "**"
9
9
precedence = "aggregate"
10
-
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and UI5 Tooling contributors"
10
+
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and UI5 CLI extensions contributors"
If you need help setting something up, or if you have questions regarding packages part of UI5 Tooling Extensions, please refrain from opening an issue on GitHub.
3
+
If you need help setting something up, or if you have questions regarding packages part of UI5 CLI Extensions, please refrain from opening an issue on GitHub.
4
4
5
5
Instead, please use one of the following platforms to seek help:
* The [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://join.slack.com/t/openui5/shared_invite/zt-1q128gn3p-JeZTi9XCpPxW8kBohSgqnw).
9
9
10
-
If you want to report an issue or request a new feature, please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling-extensions/blob/main/CONTRIBUTING.md#-feature-requests).
10
+
If you want to report an issue or request a new feature, please follow our [Contribution Guidelines](https://github.com/UI5/cli-extensions/blob/main/CONTRIBUTING.md#-feature-requests).
0 commit comments