-
Notifications
You must be signed in to change notification settings - Fork 8.3k
doc: add contributing non-Apache2.0 docs #1561
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
nashif
merged 1 commit into
zephyrproject-rtos:master
from
dbkinder:z1543-non-apache2-contributions
Sep 22, 2017
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| [Code Component Name] | ||
| ##################### | ||
|
|
||
| Origin: | ||
| [Name of project hosting the original open source code] | ||
| [Provide a link to the source] | ||
|
|
||
| Status: | ||
| [Current version of this component, supported by Zephyr] | ||
|
|
||
| Purpose: | ||
| [Brief description of what this software does] | ||
|
|
||
| Description: | ||
| [Long description that will help reviewers discuss suitability of the | ||
| package to solve the problem at hand (there may be a better package | ||
| available.) | ||
|
|
||
| What is its primary functionality (e.g., SQLLite is a lightweight | ||
| database)? | ||
|
|
||
| What problem are you trying to solve? (e.g., a state store is | ||
| required to maintain ...) | ||
|
|
||
| Why is this the right package to solve it (e.g., SQLite is small, | ||
| easy to use, and has a very liberal license.)] | ||
|
|
||
| Dependencies: | ||
| [What other components does this package depend on? Does the software | ||
| include any dynamic or static linking, or automatic downloading of any | ||
| code? | ||
|
|
||
| Will the Zephyr project have a direct dependency on the component, or | ||
| will it be included via an abstraction layer with this component as a | ||
| replacable implementation?] | ||
|
|
||
| URL: | ||
| [location to the project's home, e.g., a github repo] | ||
|
|
||
| commit: | ||
| [08ded7f21529c39e5133688ffb9a9d0c94e5c6e] | ||
|
|
||
| Maintained-by: | ||
| [External] | ||
|
|
||
| License: | ||
| [use SPDX identifier (https://spdx.org/licenses/), such as BSD-3-Clause] | ||
|
|
||
| License Link: | ||
| [link to the project's LICENSE file, e.g., https://github.com/xyz/LICENSE] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| .. _contribute_non-Apache: | ||
|
|
||
| Contributing non-Apache 2.0 licensed components | ||
| ############################################### | ||
|
|
||
| Importing code into the Zephyr OS from other projects that use a license | ||
| other than the Apache 2.0 license needs to be fully understood in | ||
| context and approved by the `Zephyr governing board`_. | ||
|
|
||
| .. _Zephyr governing board: | ||
| https://www.zephyrproject.org/about/organization | ||
|
|
||
| By carefully reviewing potential contributions and also enforcing a | ||
| :ref:`DCO` for contributed code, we ensure that | ||
| the Zephyr community can develop products with the Zephyr Project | ||
| without concerns over patent or copyright issues. | ||
|
|
||
| Submission and review process | ||
| ***************************** | ||
|
|
||
| All contributions to the Zephyr project are submitted through GitHub | ||
| pull requests (PR) following the Zephyr Project's :ref:`Contribution workflow`. | ||
|
|
||
| Before you begin working on including a new component to the Zephyr | ||
| Project (Apache-2.0 licensed or not), you should start up a conversation | ||
| on the `developer mailing list <https://lists.zephyrproject.org>`_ | ||
| to see what the Zephyr community thinks about the idea. Maybe there's | ||
| someone else working on something similar you can collaborate with, or a | ||
| different approach may make the new component unnecessary. | ||
|
|
||
| If the conclusion is that including a new component is the best | ||
| solution, and this new component uses a license other than Apache-2.0, | ||
| these additional steps must be followed: | ||
|
|
||
| #. Complete a README for your code component and add it to your source | ||
| code pull request (PR). A recommended README template can be found in | ||
| :file:`doc/contributing/code_component_README` (and included | ||
| `below`_ for reference) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Internal reference; shouldn't this be: |
||
|
|
||
| #. The Zephyr Techincal Steering Committee (TSC) will evaluate the code | ||
| component README as part of the PR | ||
| commit and vote on accepting it using the GitHub PR review tools. | ||
|
|
||
| - If rejected by the TSC, a TSC member will communicate this to | ||
| the contributor and the PR will be closed. | ||
|
|
||
| - If approved by the TSC, the TSC chair will forward the README to | ||
| the Zephyr governing board for further review. | ||
|
|
||
| #. The Zephyr governing board has two weeks to review and ask questions: | ||
|
|
||
| - If there are no objections, the matter is closed. Approval can be | ||
| accelerated by unanimous approval of the board before the two | ||
| weeks are up. | ||
|
|
||
| - If a governing board member raises an objection that cannot be resolved | ||
| via email, the board will meet to discuss whether to override the | ||
| TSC approval or identify other approaches that can resolve the | ||
| objections. | ||
|
|
||
| #. On approval of the Zephyr TSC and governing board, final review of | ||
| the PR may be made to ensure its proper placement in the | ||
| Zephyr Project :ref:`source_tree_v2`, (in the ``ext`` folder), and | ||
| inclusion in the :ref:`zephyr_licensing` document. | ||
|
|
||
| .. note:: | ||
|
|
||
| External components not under the Apache-2.0 license **cannot** be | ||
| included in a Zephyr OS release without approval of both the Zephyr TSC | ||
| and the Zephyr governing board. | ||
|
|
||
| .. _below: | ||
|
|
||
| Code component README template | ||
| ****************************** | ||
|
|
||
| .. literalinclude:: code_component_README | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"permissive" typo