Difference between revisions of "Technical Team/Use Cases/2.0/Committer annotates source files with SPDX data"
From SPDX Wiki
Line 1: | Line 1: | ||
− | <ol style="color: #4d4d4d; font-family: Arial, Helvetica, sans-serif; font-size: 13px;"><li><strong>Title:</strong> Committer annotates source files with SPDX data</li><li><strong>Primary Actor:</strong> Committer</li><li><strong>Goal in Context:</strong> To indicate in the file | + | <ol style="color: #4d4d4d; font-family: Arial, Helvetica, sans-serif; font-size: 13px;"><li><strong>Title:</strong> Committer annotates source files with SPDX data</li><li><strong>Primary Actor:</strong> Committer</li><li><strong>Goal in Context:</strong> To indicate SPDX data for the file in the source code file.</li><li><strong>Preconditions:</strong> <ol><li>Committer has decided the license for the file they are committing</li></ol></li><li><strong>Stakeholders and Interests:</strong> <ol><li><strong>Committer:</strong> <ol><li>To communicate the license information for the file in line with the file.</li></ol></li><li><strong>Upstream maintainers: </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. </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> 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> 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: </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
- Title: Committer annotates source files with SPDX data
- Primary Actor: Committer
- Goal in Context: To indicate SPDX data for the file in the source code file.
- Preconditions:
- Committer has decided the license for the file they are committing
- Stakeholders and Interests:
- Committer:
- To communicate the license information for the file in line with the file.
- Upstream maintainers:
- To be able to have the source code be self documenting in a machine and human readable manner with respect to license information.
- To communicate the licensing information for their copyrightable artifacts.
- To have their licenses respected
- Consumers of upstream source:
- To receive accurate and clear information of licensing of upstream source
- To be able to comply easily with licenses for upstream source
- To be able to subset, extend, or aggregate artifacts and pass on clear authoritative verifiable license for the resulting new copyrightable artifacts.
- Committer:
- 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.
- Failed End Condition: Source code files lack complete accurate SPDX data.
- Trigger:
- Commit of code to an upstream project.
- 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.