Difference between revisions of "Technical Team/Use Cases/2.0/Consuming code snippets"

<ol><li><strong>Title:</strong> Consuming Code Snippets</li><li><strong>Primary Actor:</strong> Committer / submitter of code to either an open source project or a commercial product</li><li><strong>Goal in Context:</strong> To include small amounts of code with implement specific functionality or algorithms developed by the open source community</li><li><strong>Stakeholders and Interests: </strong></li><ol><li><p><strong>Committers to the open source project: </strong></p><ol><li>Leverage pre-existing algorithms or functionality (e.g. MD5 Hash Algorithm) within a license compatible with the open source license</li></ol></li><li><strong>Submitter to a commercial product:</strong><ol><li>Leverage pre-existing algorithms or functionality (e.g. MD5 Hash Algorithm) within a license compatible with the commercial license</li></ol></li><li><strong>Downstream consumers of the resultant software:</strong></li><ol><li>Adhere to the license obligations of the code snippet</li></ol><li><strong>Legal/compliance for the consuming organization:</strong></li><ol><li>Adhere to the license obligations of the code snippet</li></ol></ol><li><strong>Preconditions:</strong></li><ol><li>Open source project containing code snippet is available/accessible</li><li>Licensing for the project containing the code snippet is available or the author can be contacted for permission to use</li></ol><li><strong>Main Success Scenario:</strong> Committer provides complete licensing information and an includes within the source file comments indicating the origin of the code snippets.&nbsp; Licensing information is included in the SPDX file provided with the source code product along with information on the location of the code snippet.&nbsp;&nbsp;Downstream consumer aggregate the license information from the Snippet with the license information from the rest of the package(s) to determine the full obligations.&nbsp;</li><li><strong>Failed End Condition:</strong></li><ol><li>Committer / submitter does not indicate the inclusion of the code snippet</li><li>Originator of the code snippet does not provide adequate licensing information</li><li>If insufficient info to determine if a conflict exists between the license used for the code snippet and the license for the large component</li></ol><li><strong>Trigger:</strong></li><ol><li>Development of code</li></ol><li><strong>Example:</strong> A file implementing a verification algorithm specific to a package needs to implement an hash algorithm in a compatible manner to another open source project.&nbsp; The code implementing the hash is copied into the source file which implements the verification algorithm.</li></ol>