diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2cf04bf1ae..ccdff1edb1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,15 +6,15 @@ 4. [💻 **Contributing Code**](#-contributing-code) ### ⚡️ Quick Links for Maintainers -- [All Open Pull Requests (cross-repo)](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+repo%3AUI5%2Fcli+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs) -- [Pull Request Queue (cross-repo)](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Apr+-label%3Adependencies+-label%3ARFC+is%3Aopen+no%3Aassignee+sort%3Aupdated-desc+repo%3AUI5%2Fcli+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs+repo%3ASAP%2Fgrunt-openui5+repo%3ASAP%2Fless-openui5+repo%3ASAP%2Fconnect-openui5+repo%3ASAP%2Fkarma-openui5+repo%3ASAP%2Fopenui5-sample-app) +- [All Open Pull Requests](https://github.com/UI5/cli/pulls?q=is%3Aopen+is%3Apr) +- [Pull Request Queue](https://github.com/UI5/cli/pulls?q=is%3Apr+-label%3Adependencies+-label%3ARFC+is%3Aopen+no%3Aassignee+sort%3Aupdated-desc) ## 📝 Reporting Issues ### Seeking Help / Not a Bug 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). ### How to Report an Issue -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 CLI](https://github.com/UI5/cli) repository. +We collect issues for all UI5 CLI packages (*ui5-cli*, *ui5-server*, *ui5-project*, *ui5-builder*, *ui5-fs*, and *ui5-logger*) in [this](https://github.com/UI5/cli) monorepo. All packages are developed and maintained within this single mono repository. 1. **Only UI5 CLI issues** * Please do not report: @@ -57,12 +57,12 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi #### Specific issue categories for UI5 CLI: * **`documentation`**: This issue is about wrong documentation. * **`needs triage`**: This issue needs to be investigated and confirmed as a valid issue that is not a duplicate -* **`module/ui5-builder`**: This issue is related to the UI5 Builder module -* **`module/ui5-cli`**: This issue is related to the UI5 CLI module -* **`module/ui5-fs`**: This issue is related to the UI5 FS module -* **`module/ui5-logger`**: This issue is related to the UI5 Logger module -* **`module/ui5-project`**: This issue is related to the UI5 Project module -* **`module/ui5-server`**: This issue is related to the UI5 Server module +* **`module/ui5-builder`**: This issue is related to the UI5 Builder package +* **`module/ui5-cli`**: This issue is related to the UI5 CLI package +* **`module/ui5-fs`**: This issue is related to the UI5 FS package +* **`module/ui5-logger`**: This issue is related to the UI5 Logger package +* **`module/ui5-project`**: This issue is related to the UI5 Project package +* **`module/ui5-server`**: This issue is related to the UI5 Server package ##### Status of an open issue: * **`information required`**: The author is required to provide information. @@ -89,7 +89,7 @@ For bigger features an RFC (Request for Comment) might be necessary. You should ## 🔍 Analyzing Issues Analyzing issue reports can be a lot of effort. Any help is welcome! 👍 -Open the [Bug Triage Project Board](https://github.com/orgs/SAP/projects/2) and look for open issues which require triage, additional work, or a bugfix. +Open the [Issues Page](https://github.com/UI5/cli/issues) and look for open issues which require triage, additional work, or a bugfix. Especially check for issues in the **`Needs Triage`** column, or for issues with the labels **`good first issue`**, **`help wanted`**, or **`information required`**. 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. 🙌 @@ -113,11 +113,11 @@ This DCO replaces the previously used CLA ("Contributor License Agreement") as w ### How to Contribute 1. Make sure the change is welcome (see [General Remarks](#general-remarks)). - - 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. -1. Create a branch by forking the relevant module repository and apply your change. + - Also check on the [UI5 CLI Issues](https://github.com/UI5/cli/issues) whether related tasks are already being worked on, blocked, or in discussion. +1. Create a branch by forking this repository and apply your change. 1. Commit and push your change on that branch. - 👉 **Please follow our [Development Conventions and Guidelines](docs/Guidelines.md).** -1. Create a pull request in the relevant repository. +1. Create a pull request in this repository. 1. Follow the link posted by the CLA assistant to your pull request and accept it, as described above. 1. Wait for our code review and approval, possibly enhancing your change on request. - Note that the UI5 developers have many duties. So, depending on the required effort for reviewing, testing, and clarification, this may take a while. diff --git a/README.md b/README.md index 91a72e8f68..065db7ad55 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,16 @@ - [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md) - [Roadmap](https://github.com/UI5/cli/issues/701) -## Modules +## Packages -UI5 CLI consists of multiple modules. Each one is managed in a separate repository: +UI5 CLI consists of multiple packages managed within this monorepo: -- [ui5-cli](https://github.com/SAP/ui5-cli): UI5 Command Line Interface, utilizing all of the following modules -- [ui5-project](https://github.com/SAP/ui5-project): Modules for building a UI5 project's dependency tree, including configuration -- [ui5-server](https://github.com/SAP/ui5-server): Modules for running a UI5 development server -- [ui5-builder](https://github.com/SAP/ui5-builder): Modules for building UI5 projects -- [ui5-fs](https://github.com/SAP/ui5-fs): UI5 specific file system abstraction -- [ui5-logger](https://github.com/SAP/ui5-logger): Internal logging module +- **packages/cli**: UI5 Command Line Interface, utilizing all of the following packages +- **packages/project**: Modules for building a UI5 project's dependency tree, including configuration +- **packages/server**: Modules for running a UI5 development server +- **packages/builder**: Modules for building UI5 projects +- **packages/fs**: UI5 specific file system abstraction +- **packages/logger**: Internal logging module **Usage Overview** *(arrows indicate dependencies)* ![Module Overview](./docs/images/Module_overview.png) diff --git a/rfcs/0000-template.md b/rfcs/0000-template.md index 94df82194d..b0789e75fb 100644 --- a/rfcs/0000-template.md +++ b/rfcs/0000-template.md @@ -2,12 +2,12 @@ - RFC PR: - - Issue: - - Affected components - + [ ] [ui5-builder](https://github.com/SAP/ui5-builder) - + [ ] [ui5-server](https://github.com/SAP/ui5-server) - + [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - + [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - + [ ] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) + + [ ] [ui5-builder](./packages/builder) + + [ ] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [ ] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0000 Fancy Title diff --git a/rfcs/0002-project-shims.md b/rfcs/0002-project-shims.md index 121e653eca..ac1512b8f1 100644 --- a/rfcs/0002-project-shims.md +++ b/rfcs/0002-project-shims.md @@ -1,13 +1,13 @@ - Start Date: 2018-04-03 - RFC PR: [#5](https://github.com/UI5/cli/pull/5) - Issue: - -- Affected components - + [ ] [ui5-builder](https://github.com/SAP/ui5-builder) - + [ ] [ui5-server](https://github.com/SAP/ui5-server) - + [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - + [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - + [x] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) +- Affected components + + [ ] [ui5-builder](./packages/builder) + + [ ] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [x] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0002 Project Shims ## Summary diff --git a/rfcs/0004-simple-build-extensibility.md b/rfcs/0004-simple-build-extensibility.md index e56f18a745..c5ac6ee169 100644 --- a/rfcs/0004-simple-build-extensibility.md +++ b/rfcs/0004-simple-build-extensibility.md @@ -1,13 +1,13 @@ - Start Date: 2018-08-28 - RFC PR: [#54](https://github.com/UI5/cli/pull/54) - Issue: - -- Affected components - + [x] [ui5-builder](https://github.com/SAP/ui5-builder) - + [ ] [ui5-server](https://github.com/SAP/ui5-server) - + [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - + [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - + [x] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) +- Affected components + + [x] [ui5-builder](./packages/builder) + + [ ] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [x] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0004 Simple Build Extensibility ## Summary diff --git a/rfcs/0005-server-middleware-extensibility.md b/rfcs/0005-server-middleware-extensibility.md index df19e37049..bf46b825fb 100644 --- a/rfcs/0005-server-middleware-extensibility.md +++ b/rfcs/0005-server-middleware-extensibility.md @@ -1,13 +1,13 @@ - Start Date: 2019-04-23 - RFC PR: [#151](https://github.com/UI5/cli/pull/151) - Issue: [#113](https://github.com/SAP/ui5-server/issues/113) -- Affected components - + [ ] [ui5-builder](https://github.com/SAP/ui5-builder) - + [x] [ui5-server](https://github.com/SAP/ui5-server) - + [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - + [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - + [x] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) +- Affected components + + [ ] [ui5-builder](./packages/builder) + + [x] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [x] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0005 Server Middleware Extensibility ## Summary diff --git a/rfcs/0006-local-dependency-resolution.md b/rfcs/0006-local-dependency-resolution.md index ddfb58a687..1a106a61c5 100644 --- a/rfcs/0006-local-dependency-resolution.md +++ b/rfcs/0006-local-dependency-resolution.md @@ -1,13 +1,13 @@ - Start Date: 2019-06-11 - RFC PR: [#157](https://github.com/UI5/cli/pull/157) - Issue: - -- Affected components - + [ ] [ui5-builder](https://github.com/SAP/ui5-builder) - + [ ] [ui5-server](https://github.com/SAP/ui5-server) - + [X] [ui5-cli](https://github.com/SAP/ui5-cli) - + [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - + [X] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) +- Affected components + + [ ] [ui5-builder](./packages/builder) + + [ ] [ui5-server](./packages/server) + + [x] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [x] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0006 Local Dependency Resolution diff --git a/rfcs/0007-properties-file-encoding.md b/rfcs/0007-properties-file-encoding.md index 652dba9563..c7c7669d81 100644 --- a/rfcs/0007-properties-file-encoding.md +++ b/rfcs/0007-properties-file-encoding.md @@ -3,13 +3,13 @@ - Start Date: 2019-07-15 - RFC PR: [#168](https://github.com/UI5/cli/pull/168) - Issue: [#161](https://github.com/UI5/cli/issues/161) -- Affected components - - [x] [ui5-builder](https://github.com/SAP/ui5-builder) - - [x] [ui5-server](https://github.com/SAP/ui5-server) - - [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - - [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - - [ ] [ui5-project](https://github.com/SAP/ui5-project) - - [ ] [ui5-logger](https://github.com/SAP/ui5-logger) +- Affected components + + [x] [ui5-builder](./packages/builder) + + [x] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [ ] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) ## Summary diff --git a/rfcs/0008-resource-tagging-during-build.md b/rfcs/0008-resource-tagging-during-build.md index 54c71e6eae..08a4701220 100644 --- a/rfcs/0008-resource-tagging-during-build.md +++ b/rfcs/0008-resource-tagging-during-build.md @@ -2,12 +2,12 @@ - RFC PR: [#243](https://github.com/UI5/cli/pull/243) - Issue: Related to https://github.com/SAP/ui5-fs/issues/155 - Affected components - + [x] [ui5-builder](https://github.com/SAP/ui5-builder) - + [ ] [ui5-server](https://github.com/SAP/ui5-server) - + [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - + [x] [ui5-fs](https://github.com/SAP/ui5-fs) - + [ ] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) + + [x] [ui5-builder](./packages/builder) + + [ ] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [x] [ui5-fs](./packages/fs) + + [ ] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0008 Resource Tagging During Build diff --git a/rfcs/0009-ui5-project-refactoring.md b/rfcs/0009-ui5-project-refactoring.md index 93d1739cc4..230d917c0b 100644 --- a/rfcs/0009-ui5-project-refactoring.md +++ b/rfcs/0009-ui5-project-refactoring.md @@ -2,12 +2,12 @@ - RFC PR: https://github.com/UI5/cli/pull/501 - Issue: - - Affected components - + [x] [ui5-builder](https://github.com/SAP/ui5-builder) - + [x] [ui5-server](https://github.com/SAP/ui5-server) - + [x] [ui5-cli](https://github.com/SAP/ui5-cli) - + [x] [ui5-fs](https://github.com/SAP/ui5-fs) - + [x] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) + + [x] [ui5-builder](./packages/builder) + + [x] [ui5-server](./packages/server) + + [x] [ui5-cli](./packages/cli) + + [x] [ui5-fs](./packages/fs) + + [x] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0009 UI5 Project Refactoring diff --git a/rfcs/0010-ui5-builder-bundling-refactoring.md b/rfcs/0010-ui5-builder-bundling-refactoring.md index 0d4191e157..e05f810122 100644 --- a/rfcs/0010-ui5-builder-bundling-refactoring.md +++ b/rfcs/0010-ui5-builder-bundling-refactoring.md @@ -2,12 +2,12 @@ - RFC PR: [#583](https://github.com/UI5/cli/pull/583) - Issue: - - Affected components - + [x] [ui5-builder](https://github.com/SAP/ui5-builder) - + [ ] [ui5-server](https://github.com/SAP/ui5-server) - + [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - + [x] [ui5-fs](https://github.com/SAP/ui5-fs) - + [ ] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) + + [x] [ui5-builder](./packages/builder) + + [ ] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [x] [ui5-fs](./packages/fs) + + [ ] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0010 UI5 Builder-Bundling Refactoring diff --git a/rfcs/0012-UI5-Tooling-Extension-API-3.md b/rfcs/0012-UI5-Tooling-Extension-API-3.md index f777a3515f..950b633f4d 100644 --- a/rfcs/0012-UI5-Tooling-Extension-API-3.md +++ b/rfcs/0012-UI5-Tooling-Extension-API-3.md @@ -2,12 +2,12 @@ - RFC PR: [#664](https://github.com/UI5/cli/pull/664) - Issue: - - Affected components - + [ ] [ui5-builder](https://github.com/SAP/ui5-builder) - + [x] [ui5-server](https://github.com/SAP/ui5-server) - + [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - + [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - + [x] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) + + [ ] [ui5-builder](./packages/builder) + + [x] [ui5-server](./packages/server) + + [ ] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [x] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0012 UI5 CLI Extension API v3 diff --git a/rfcs/0013-configuration.md b/rfcs/0013-configuration.md index 30c9aa5f46..966c7890c2 100644 --- a/rfcs/0013-configuration.md +++ b/rfcs/0013-configuration.md @@ -2,12 +2,12 @@ - RFC PR: [#787](https://github.com/UI5/cli/pull/787) - Issue: - - Affected components - + [ ] [ui5-builder](https://github.com/SAP/ui5-builder) - + [ ] [ui5-server](https://github.com/SAP/ui5-server) - + [x] [ui5-cli](https://github.com/SAP/ui5-cli) - + [ ] [ui5-fs](https://github.com/SAP/ui5-fs) - + [x] [ui5-project](https://github.com/SAP/ui5-project) - + [ ] [ui5-logger](https://github.com/SAP/ui5-logger) + + [ ] [ui5-builder](./packages/builder) + + [ ] [ui5-server](./packages/server) + + [x] [ui5-cli](./packages/cli) + + [ ] [ui5-fs](./packages/fs) + + [x] [ui5-project](./packages/project) + + [ ] [ui5-logger](./packages/logger) # RFC 0013 Configuration