THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx

Difference between revisions of "Technical Team/Use Cases/2.0/Committer annotates source files with SPDX data"

From SPDX Wiki
Jump to: navigation, search
 
Line 1: Line 1:
<ol style="color: #4d4d4d; font-family: Arial, Helvetica, sans-serif; font-size: 13px;"><li><strong>Title:</strong>&nbsp;Committer annotates source files with SPDX data</li><li><strong>Primary Actor:</strong>&nbsp;Committer</li><li><strong>Goal in Context:</strong>&nbsp;To indicate in the file their SPDX data for that file</li><li><strong>Stakeholders and Interests:</strong>&nbsp;<ol><li><strong>Committer:</strong>&nbsp;<ol><li>To communicate in the source file the SPDX data that applies to the file</li></ol></li><li><strong>Upstream maintainers:&nbsp;</strong><ol><li>To be able to document the license information for the commits they receive</li><li>To communicate the licensing information for their copyrightable artifacts. &nbsp;</li><li>To have their licenses respected</li></ol></li><li><strong>Consumers of upstream source:</strong><ol><li>To receive accurate and clear information of licensing of upstream source</li><li>To be able to comply easily with licenses for upstream source</li><li>To be able to subset, extend, or aggregate artifacts and pass on clear authoritative verifiable license for the resulting new copyrightable artifacts.</li></ol></li></ol></li><li><strong>Preconditions:</strong>&nbsp;<ol><li>Committer has decided to accept the licensing for the upstream project</li><li>The Upstream Maintainer is providing SPDX data for the upstream project.</li></ol></li><li><strong>Main Success Senario:</strong>&nbsp;Committer communicates &nbsp;in the file the SPDX data for the file.</li><li><strong>Failed End Condition:</strong>&nbsp;Committer communicates inaccurate incomplete licensing information for their package.</li><li><strong>Trigger:</strong><ol><li>Commit of code to an upstream project.</li></ol></li><li><strong>Notes:</strong>&nbsp;This use case needs work, it's probably *not* about the committer here, but the inline marking of source code files is interesting.&nbsp;</li></ol>
+
<ol style="color: #4d4d4d; font-family: Arial, Helvetica, sans-serif; font-size: 13px;"><li><strong>Title:</strong>&nbsp;Committer annotates source files with SPDX data</li><li><strong>Primary Actor:</strong>&nbsp;Committer</li><li><strong>Goal in Context:</strong>&nbsp;To indicate SPDX data for the file in the source code file.</li><li><strong>Preconditions:</strong>&nbsp;<ol><li>Committer has decided the license for the file they are committing</li></ol></li><li><strong>Stakeholders and Interests:</strong>&nbsp;<ol><li><strong>Committer:</strong>&nbsp;<ol><li>To communicate the license information for the file in line with the file.</li></ol></li><li><strong>Upstream maintainers:&nbsp;</strong><ol><li>To be able to have the source code be self documenting in a machine and human readable manner with respect to license information.</li><li>To communicate the licensing information for their copyrightable artifacts. &nbsp;</li><li>To have their licenses respected</li></ol></li><li><strong>Consumers of upstream source:</strong><ol><li>To receive accurate and clear information of licensing of upstream source</li><li>To be able to comply easily with licenses for upstream source</li><li>To be able to subset, extend, or aggregate artifacts and pass on clear authoritative verifiable license for the resulting new copyrightable artifacts.</li></ol></li></ol></li><li><strong>Main Success Senario:</strong>&nbsp;Source code files contain complete accurate SPDX data sufficient to communicate their licensing information in a way that is both human and machine readable.</li><li><strong>Failed End Condition:</strong>&nbsp;Source code files lack complete accurate SPDX data.</li><li><strong>Trigger:</strong><ol><li>Commit of code to an upstream project.</li></ol></li><li><strong>Notes:&nbsp;</strong>There may be sub-use cases here around the distinction between original authorship of a file and capturing in SPDX existing information about the file, either from existing file headers or from commit logs.</li></ol>

Revision as of 17:50, 17 April 2012

  1. Title: Committer annotates source files with SPDX data
  2. Primary Actor: Committer
  3. Goal in Context: To indicate SPDX data for the file in the source code file.
  4. Preconditions: 
    1. Committer has decided the license for the file they are committing
  5. Stakeholders and Interests: 
    1. Committer: 
      1. To communicate the license information for the file in line with the file.
    2. Upstream maintainers: 
      1. To be able to have the source code be self documenting in a machine and human readable manner with respect to license information.
      2. To communicate the licensing information for their copyrightable artifacts.  
      3. To have their licenses respected
    3. Consumers of upstream source:
      1. To receive accurate and clear information of licensing of upstream source
      2. To be able to comply easily with licenses for upstream source
      3. To be able to subset, extend, or aggregate artifacts and pass on clear authoritative verifiable license for the resulting new copyrightable artifacts.
  6. Main Success Senario: Source code files contain complete accurate SPDX data sufficient to communicate their licensing information in a way that is both human and machine readable.
  7. Failed End Condition: Source code files lack complete accurate SPDX data.
  8. Trigger:
    1. Commit of code to an upstream project.
  9. Notes: There may be sub-use cases here around the distinction between original authorship of a file and capturing in SPDX existing information about the file, either from existing file headers or from commit logs.