diff --git a/en/contribute/code-contribution.md b/en/contribute/code-contribution.md index b96d15df710a082c285b2df6f33e86bf96c7bb29..6b540115fac2034d50361bf0d9f62aee451f94b4 100644 --- a/en/contribute/code-contribution.md +++ b/en/contribute/code-contribution.md @@ -6,7 +6,7 @@ - [OpenHarmony API Governance Charter](../design/OpenHarmony-API-governance.md) - [OpenHarmony Security Design Specifications](OpenHarmony-security-design-guide.md) -- [OpenHarmony Security Design Specifications](OpenHarmony-security-design-guide.md) +- [OpenHarmony Build Specifications](https://gitee.com/openharmony/community/blob/master/sig/sig-buildsystem/sig-build-system.md) ### Coding Style @@ -17,18 +17,22 @@ Develop, review, and test code following the OpenHarmony coding standards. Make - [JavaScript Coding Style Guide](OpenHarmony-JavaScript-coding-style-guide.md) - [Python Coding Style Guide](https://pep8.org/) - [C&C++ Secure Coding Guide](OpenHarmony-c-cpp-secure-coding-guide.md) -- [HDF Driver Coding Guide](OpenHarmony-Java-secure-coding-guide.md) -- [32- and 64-Bit Portability Coding Guide](OpenHarmony-64bits-coding-guide.md) - [Java Secure Coding Guide](OpenHarmony-Java-secure-coding-guide.md) +- [32- and 64-Bit Portability Coding Guide](OpenHarmony-64bits-coding-guide.md) +- [HDF Driver Coding Guide](OpenHarmony-hdf-coding-guide.md) - [Logging Guide](OpenHarmony-Log-guide.md) +### Introducing Open-source Software + +For details, see [Introducing Open-Source Software](introducing-open-source-software.md). + ## Contribution Workflow For details, see [Contribution Process](contribution-process.md). ## Security Issue Disclosure -- [Security Issue Handling and Release Processes](https://gitee.com/openharmony/security/blob/master/en/security-process/README.md) -- [OpenHarmony Security Vulnerability Notice](https://gitee.com/openharmony/security/blob/master/en/security-process/security-disclosure.md) +- [OpenHarmony Security Vulnerability Governance](https://gitee.com/openharmony/security/blob/master/en/security-process/README.md) +- [OpenHarmony Security and Disclosure Statement](https://gitee.com/openharmony/security/blob/master/en/security-process/security-disclosure.md) diff --git a/en/contribute/introducing-third-party-open-source-software.md b/en/contribute/introducing-open-source-software.md similarity index 68% rename from en/contribute/introducing-third-party-open-source-software.md rename to en/contribute/introducing-open-source-software.md index 3fd15c24b6df07403b77eff0e71d71cb2dea6414..5e6422ec95485848e98dbe9796c96c274f9d5662 100644 --- a/en/contribute/introducing-third-party-open-source-software.md +++ b/en/contribute/introducing-open-source-software.md @@ -1,4 +1,4 @@ -# Introducing Third-Party Open-Source Software +# Introducing Open-Source Software ## Purpose @@ -12,7 +12,7 @@ This guide applies to all third-party open-source software to be introduced to t ## Improvements and Revisions 1. This document is drafted and maintained by the OpenHarmony SIG QA. What you are reading now is the latest version of this document. - + 2. Any addition, modification, or deletion of the principles mentioned in this document can be traced in the tracing system. 3. The PMC reviews and finalizes the principles after thorough discussion in the community. @@ -29,33 +29,17 @@ For easier maintenance and evolution, comply with the following principles when 1. Make sure the software comes from a clearly defined upstream community. 2. Provide a sound reason for software introduction. If the software to be introduced already exists in the OpenHarmony project, reuse it to avoid maintenance complexity caused by coexistence of multiple versions. 3. 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. -4. Make sure the software can be correctly built on the OpenHarmony 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 SIG-Architecture should review the request and make a decision. -5. Place the software in an independent code repository and name it in the format of **third_party**_**softwareName**, where *softwareName* must be an official name. +4. Make sure the software can be correctly built on the OpenHarmony 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 Architecture SIG should review the request and make a decision. +5. Place the software in an independent code repository and name it in the format of third_party_softwareName, where *softwareName* must be an official name. 6. 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. 7. Do not introduce any software version that has not been officially released, for example, the Beta version. 8. Do not introduce any software version that has high-risk vulnerabilities and does not provide solutions. 9. 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). 10. 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. -11. Make sure the software you introduce is under the custody of a domain SIG. In principle, the SIG-Architecture will deny the introduction of a piece of software without the confirmation of the SIG-Compliance and the corresponding domain SIG. When introducing multiple pieces of software at a time, you can ask the PMC to hold a temporary review meeting between SIGs for faster introduction. If you want to introduce a piece of software but fail to meet the preceding requirements, send an email to oh-legal@openatom.io. -12. When software introduction depends on other dependency software, it is not allowed to nest the dependency software in the subdirectory of the software introduction, and all dependency software must be placed in separate repository, and name it in the format of **third_party_*****softwareName***, because nested placement of dependency software may lead to multiple versions of the same software, old versions of security vulnerabilities cannot be fixed in a timely, and will risk the open-source compliance issues. - - Dependency software is named in the compiled **BUILD.gn** with part name by prefixing the new software introduction name, e.g. part_name = "software_introduction_name_dependency software_name". - - The inter-component dependencies between software introduction and dependency software are resolved via external_deps. -13. OpenHarmony's archiving directory requirements for third-party software introduction. - - If you don't have a really good reason to store it elsewhere and under one of the permitted licenses belongs in third_party. - - For the dedicated third-party software introduction which belongs to the special devboard, and is not suitable introduced into the OpenHarmony platform, you could apply to store it in the following locations, Naming it in the format of **softwareName**, where **softwareName** must be an official name, and create the **README.OpenSource** description file in the corresponding directory; Creating **BUILD.gn** to build it independently to support the automatic collection of open source obligation declaration. - - ``` - device/soc/$(SOC_COMPANY)/third_party - device/board/$(BOARD_COMPANY)/third_party - vendor/$(PRODUCT_COMPANY)/third_party - ``` - -14. Precompiled binary or toolchain used in the OpenHarmony, the following information needs to be provided. - - The source code corresponding to the precompiled binary or toolchain, which needs to store the corresponding source code in the OpenHarmony community, and provide the corresponding build guide, and provide open source obligation statement guide; - - Third-party software introduction for precompiled binary or toolchain, need to meet the principles 1 ~ 13; - - The [prebuilt toolchain's description documentation](./prebuilts-readme-template.md): including source code acquisition address, build instructions, update methods, archived in the toolchain root directory with the toolchain build; - - The root directory corresponding to the precompiled binary or toolchain needs to provide notice file of the full open source obligation statement; - - If the precompiled binary files come from upstream service platform (e.g. npm packages, etc.). We need to provide the following information in the place where the binary is archived, first we need to provide a general description with the name **README**, include the following information: background description of the introduction and official website; next we need to provide an open-source obligation statement file with the name **NOTICE**, include the following information: software name, version, copyrights, and license information of every third-party open-source software. +11. Make sure the software you introduce is under the custody of a domain SIG. In principle, the Architecture SIG will reject a software introduction request if it has not been confirmed by the Compliance SIG and the corresponding domain SIG. When introducing multiple pieces of software at a time, you can ask the Architecture SIG to hold a one-off review meeting between SIGs for faster introduction. If you want to introduce a piece of software but fail to meet the preceding requirements, send an email to oh-legal@openatom.io. +12. If the software you introduce depends on other open-source software, do not nest the dependency software in the subdirectory of the software you introduce. Instead, remove all dependency software items from the software you introduce and place them in an independent repository named in the format of **third_party_*****dependencySoftwareName***. If you nest the dependency software, the same software may have multiple versions, security vulnerabilities in earlier versions may fail to be resolved in a timely manner, and open source compliance issues may arise. + - Prefix the component names of the dependency software in the **BUILD.gn** file with the name of the software you introduce, for example, part_name = "introducedSoftwareName_dependencySoftwareName". + - The software you introduce and dependency software are built separately. Use **external_deps** to resolve the inter-component dependency between the two pieces of software. ### Software Introduction Process @@ -63,11 +47,11 @@ For easier maintenance and evolution, comply with the following principles when | Check Item| Description| | :----- | :----- | -| Normalization| Check whether the software exists in the OpenHarmony community. In principle, a piece of software is introduced to the OpenHarmony only once.| -| Source| Check whether the software is downloaded from its official website or source specified on the official website.| +| Normalization| 1. Check whether the software exists in the OpenHarmony community. In principle, a piece of software is introduced to the OpenHarmony only once.| +| Source| 1. 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.| +| 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.| @@ -77,13 +61,13 @@ Follow the process described in the [SIG Management Regulations](https://gitee.c 1. Self-check list -| Check Item| Description| Self-Check Result Example| +| 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.| | +| 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.| | +| 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://gitee.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.| @@ -137,9 +121,9 @@ Confirm the issues found by the OAT tool and configure the **OAT.xml** file. For ] ``` -#### Open source software introduction Review +#### PMC Review -Refer to the [SIG-Architecture](https://gitee.com/openharmony/community/blob/master/sig/sig-architecture/sig-architecture_cn.md). The SIG-Architecture will arrange the review of the applying of creating new repository. +Refer to the [SIG Management Regulations](https://gitee.com/openharmony/community/tree/master/sig). The PMC will arrange the SIG request review and repository construction based on the received PR. ### License Requirements for Third-Party Open-Source Software @@ -147,66 +131,66 @@ Refer to the [SIG-Architecture](https://gitee.com/openharmony/community/blob/mas 2. The software license must be compatible with the license for the code repository. 3. The following licenses for third-party open-source software are recommended in the OpenHarmony project: -- Apache License 2.0 -- Mulan Permissive Software License, Version 2 -- BSD 2-clause -- BSD 3-clause -- DOM4J License -- PostgreSQL License -- Eclipse Distribution License 1.0 -- MIT -- ISC -- ICU -- University of Illinois/NCSA -- W3C Software License -- zlib/libpng -- Academic Free License 3.0 -- Python Software Foundation License -- Python Imaging Library Software License -- Boost Software License Version 1.0 -- WTF Public License -- UNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWARE -- Zope Public License 2.0 +* Apache License 2.0 +* Mulan Permissive Software License, Version 2 +* BSD 2-clause +* BSD 3-clause +* DOM4J License +* PostgreSQL License +* Eclipse Distribution License 1.0 +* MIT +* ISC +* ICU +* University of Illinois/NCSA +* W3C Software License +* zlib/libpng +* Academic Free License 3.0 +* Python Software Foundation License +* Python Imaging Library Software License +* Boost Software License Version 1.0 +* WTF Public License +* UNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWARE +* Zope Public License 2.0 4. The following licenses for third-party open-source software are not recommended in the OpenHarmony project: -- GNU GPL 1, 2, 3 -- GNU Affero GPL 3 -- GNU LGPL 2, 2.1, 3 -- QPL -- Sleepycat License -- Server Side Public License (SSPL) version 1 -- Code Project Open License (CPOL) -- BSD-4-Clause/BSD-4-Clause (University of California-Specific) -- Facebook BSD+Patents license -- NPL 1.0/NPL 1.1 -- The Solipsistic Eclipse Public License -- The "Don't Be A Dick" Public License -- JSON License -- Binary Code License (BCL) -- Intel Simplified Software License -- JSR-275 License -- Microsoft Limited Public License -- Amazon Software License (ASL) -- Java SDK for Satori RTM license -- Redis Source Available License (RSAL) -- Booz Allen Public License -- Creative Commons Non-Commercial -- Sun Community Source License 3.0 -- Common Development and Distribution Licenses: CDDL 1.0 and CDDL 1.1 -- Common Public License: CPL 1.0 -- Eclipse Public License: EPL 1.0 -- IBM Public License: IPL 1.0 -- Mozilla Public Licenses: MPL 1.0, MPL 1.1, and MPL 2.0 -- Sun Public License: SPL 1.0 -- Open Software License 3.0 -- Erlang Public License -- UnRAR License -- SIL Open Font License -- Ubuntu Font License Version 1.0 -- IPA Font License Agreement v1.0 -- Ruby License -- Eclipse Public License 2.0: EPL 2.0 +* GNU GPL 1, 2, 3 +* GNU Affero GPL 3 +* GNU LGPL 2, 2.1, 3 +* QPL +* Sleepycat License +* Server Side Public License (SSPL) version 1 +* Code Project Open License (CPOL) +* BSD-4-Clause/BSD-4-Clause (University of California-Specific) +* Facebook BSD+Patents license +* NPL 1.0/NPL 1.1 +* The Solipsistic Eclipse Public License +* The "Don't Be A Dick" Public License +* JSON License +* Binary Code License (BCL) +* Intel Simplified Software License +* JSR-275 License +* Microsoft Limited Public License +* Amazon Software License (ASL) +* Java SDK for Satori RTM license +* Redis Source Available License (RSAL) +* Booz Allen Public License +* Creative Commons Non-Commercial +* Sun Community Source License 3.0 +* Common Development and Distribution Licenses: CDDL 1.0 and CDDL 1.1 +* Common Public License: CPL 1.0 +* Eclipse Public License: EPL 1.0 +* IBM Public License: IPL 1.0 +* Mozilla Public Licenses: MPL 1.0, MPL 1.1, and MPL 2.0 +* Sun Public License: SPL 1.0 +* Open Software License 3.0 +* Erlang Public License +* UnRAR License +* SIL Open Font License +* Ubuntu Font License Version 1.0 +* IPA Font License Agreement v1.0 +* Ruby License +* Eclipse Public License 2.0: EPL 2.0 If you want to introduce the software that complies with the unrecommended licenses listed in **4** or other licenses that are not mentioned, send an email to oh-legal@openatom.io. diff --git a/en/contribute/third-party-open-source-software-and-license-notice.md b/en/contribute/open-source-software-and-license-notice.md similarity index 100% rename from en/contribute/third-party-open-source-software-and-license-notice.md rename to en/contribute/open-source-software-and-license-notice.md