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
Bschineller (Talk | contribs) |
(Convert to MediaWiki syntax) |
||
Line 1: | Line 1: | ||
− | + | # '''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. | ||
+ | # '''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 accurate SPDX data. | ||
+ | ## Source code files lack complete accurate SPDX data. | ||
+ | ## The annotation turns out not to be machine-readable (inappropriate syntax?) | ||
+ | # '''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. | ||
+ | |||
+ | [[Category:Technical]] |
Latest revision as of 13:16, 7 March 2013
- 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 accurate SPDX data.
- Source code files lack complete accurate SPDX data.
- The annotation turns out not to be machine-readable (inappropriate syntax?)
- 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.