Introducing Third-Party Open-Source Software
Purpose
In ArkUI-X, software that meets The Open Source Definition is recognized as open-source software. Providing easy-to-use and quality open-source software for developers across the globe from a wide range of backgrounds is an important goal of the ArkUI-X community. To ensure the overall quality of the ArkUI-X project, this guide is specially formulated for the contributors' reference.
Scope
This guide applies to all third-party open-source software to be introduced to the ArkUI-X project.
Improvements and Revisions
-
This document is drafted and maintained by the ArkUI-X PMC. What you are reading now is the latest version of this document.
-
Any addition, modification, or deletion of the principles mentioned in this document can be traced in the tracing system.
-
The PMC reviews and finalizes the principles after thorough discussion in the community.
Software Introduction and Introduction Principles
What Is Software Introduction?
Software introduction refers to the act of introducing a piece of software to the ArkUI-X project to meet certain service requirements in ArkUI-X. The entire process must be traceable.
Basic Principles for Software Introduction
For easier maintenance and evolution, comply with the following principles when introducing third-party open-source software:
- Make sure the software comes from a clearly defined upstream community.
- Provide a sound reason for software introduction. If the software to be introduced already exists in the ArkUI-X project, reuse it to avoid maintenance complexity caused by coexistence of multiple versions.
- Introduce the software in the form of source code, rather than binary files. If a piece of software needs to be introduced in the form of binary files, the PMC should review the request and make a decision.
- Make sure the software can be correctly built on the ArkUI-X project. If the software has dependency software that has not been introduced, or the running or build of the software depends on a component that cannot be introduced, the PMC should review the request and make a decision.
- Place the software in an independent code repository or folder and name it in the format of third_party_softwareName, where softwareName must be an official name.
- Retain the directory structure, license, and copyright information of the official code repository of the software. Do not modify the original license and copyright information.
- Do not introduce any software version that has not been officially released, for example, the Beta version.
- Do not introduce any software version that has high-risk vulnerabilities and does not provide solutions.
- If you need to modify the software, place the new code in the software repository and ensure that the new code meets the license requirements of the software. Retain the original license for the modified files, and use the same license for the new files (recommended).
- Provide the README.OpenSource file in the root directory of the software repository. Include the following information in the file: software name, license, license file location, version, upstream community address of the corresponding version, software maintenance owner, function description, and introduction reason.
Software Introduction Process
Check Before Software Introduction
| Check Item | Description |
|---|---|
| Normalization | Check whether the software exists in the ArkUI-X community. In principle, a piece of software is introduced to ArkUI-X only once. |
| Source | Check whether the software is downloaded from its official website or source specified on the official website. |
| Community activeness | 1. Do not introduce software from a community or organization that notifies users of software maintenance termination by releasing a bullet, modifying the software repository status, or moving the software repository in a specified directory. 2. Do not introduce software from an individual, a small community, or an organization that has not released a version (either official or test version) within two years, does not have a clear version roadmap, or does not respond to any valid bug or pull request in the community. 3. Do not introduce software from a community that is not longer maintained or does not respond to any operating status related issue or email for more than half a year. |
| Security vulnerability | 1. Search for disclosed security vulnerabilities in the industry, and check whether solutions are provided if there are high-risk vulnerabilities in the software. |
| Software name | 1. Name the repository in the format of third_party_softwareName, where softwareName must be the same as the official name. 2. Do not use the sub-module name of the software as the software name. 3. If the software has development libraries in multiple languages, add prefixes such as python- to the official software name for standardized management. |
| Official website information | 1. Describe the official website of the software in the request. If there is no official website, provide the project URL on a mainstream code hosting platform. Dot not use the hosting library addresses such as Maven, mvnrepository, and SpringSource. 2. Provide the official download address of the software version source package for traceability. If a binary package is required, provide the official download address of the binary package. |
| License | 1. Check whether the software to be introduced has a license. 2. Check whether the imported license is consistent with the license of the corresponding version on the official website of the software. 3. Exercise caution when introducing open-source software with high-risk licenses. Before introducing the software, fully evaluate the risk and attach the analysis conclusion in the request. |
Submitting a Request
To introduce open-source software, submit a request to the ArkUI-X PMC. Include the following information in the request:
- Self-check list
| Check Item | Description | Self-Check Result Example |
|---|---|---|
| Software name | Provide the official name of the software and the repository name to which the software is introduced. The repository name is in the format of third_party_softwareName. | third_party_softwareName |
| Official website | Provide the official website link of the software. | https://softwaresite |
| Software version | Provide the version number of the software to be introduced. The version number must be an official version number released by the community. Do not modify the version number or introduce a version that is not officially released. | 1.0.0 |
| Software version release date | Provide the official release date of the software version. | 2021.01.01 |
| Software version address | Provide the official download URL of the version. Note that the URL must be able to locate the release package of the specific version. | https://gitcode.com/softwarecodesite/v1.0.0.zip |
| Software license | Provide the official license name of the version and the relative path of the license file. If there are multiple licenses, list them all and describe their relationship, for example, And, Or, or different licenses for different directories. | Apache-2.0 |
| Software lifecycle | Describe whether the software has an LTS version, how frequent a version is released, code submitted to the community in the last year, issue resolution status, and whether end of maintenance or evolution is notified. | No LTS version; one version released every six months; 10 code submissions in the last six months |
| Security vulnerabilities | List disclosed security vulnerabilities in the software, including the vulnerability number, severity, link, and whether patches or solutions are available. | No disclosed vulnerabilities. |
| Service scenario | Describe the repositories where the software is used and the service scenarios where the software is used. | Used by the static link of the XX repository to improve the YYY capability. |
| Normalization | Describe whether the likes of the software exist in the ArkUI-X community, what similar software is in the industry, and why the software or version is introduced. | This software has not been introduced to the ArkUI-X community. Similar software in the industry includes B and C. Only this software is license-friendly and has a good ecosystem. Companies such as X and Y are also using this software. |
| License compatibility | Describe the processes that use the software, the license of each process, and whether these licenses are compatible with the license of the software to be introduced. | This software is used in the user-mode X process in static link mode. The process is licensed under Apache-2.0, which is consistent with the software license. There is no compatibility issue. |
| Owner | Provide the GitCode username and email address of the maintenance owner. | James, James@example.com |
- OAT.xml file
Confirm the issues found by the OAT tool and configure the OAT.xml file. For details, see OAT. Attach the file in the request. If no issue needs to be confirmed, you do not have to configure the file.
- README.OpenSource file of the repository. The format is as follows:
[
{
"Name": "softwarename",
"License": "Apache-2.0",
"License File": "LICENSE",
"Version Number": "1.0.0",
"Owner": "James@example.com",
"Upstream URL": "https://gitcode.com/softwarecodesite/v1.0.0.zip",
"Description": "...."
},
{
...
}// If there are multiple licenses, list them one by one.
]
PMC Approval
The PMC will arrange the PMC request review and repository construction based on the received PR.
Software Exit and Exit Principles
What Is Software Exit?
- Software exit refers to the process in which a piece of software (project) is removed as requested from the ArkUI-X project according to the principles described in this document.
- The owner responsible for the software management should submit an exit topic to the PMC for review.
Software Exit Principles
When the following two conditions are met, the software exit request is executed immediately, and the corresponding file is directly deleted from the project:
- The software license is changed or the current version is affected by laws and regulations. Due to legal risks imposed by software license changes, laws, or regulations, the ArkUI-X project cannot continue to integrate the software.
- Malicious code or serious security risks exist and cannot be fixed by the ArkUI-X community.
In other scenarios, ArkUI-X implements process-based management on software exit.
- Due to outdated technologies or architecture, the software can no longer meet the requirements of existing scenarios and needs to be replaced by other software.
- The version integrated by ArkUI-X is too old, and an upgrade to the new version is impossible because of the license of the new version or other legal and regulatory restrictions.
- For software that comes from well-known communities or organizations, the communities or organizations notify users of the software maintenance termination by releasing bulletins, modifying the software repository status, and moving the software repository to a specified directory.
- For software that comes from individuals, small communities, or organizations, no version (either official or test versions) is released within two years, no clear version plan is available, or no response is provided to any valid bug or PR for more than half a year.
- The operating status of the community is not clear, and the community does not respond to any operating status related issue or email for more than half a year or replies that the maintenance is terminated.
If the software meets any of the preceding conditions, the PMC and owner analyze the dependency and usage of the software in the ArkUI-X community.
- If a dependency exists in the ArkUI-X community and cannot be removed within a short period of time, it is recommended that the owner create a branch code repository and proactively perform community maintenance.
- If no dependency exists in the ArkUI-X community or the dependency can be removed in a short period of time, the owner removes the software from the ArkUI-X official release and describes the reason and impact of the removal in the corresponding Release Notes.