THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx
Difference between revisions of "Legal Team/Templatizing/ReviewXML"
From SPDX Wiki
< Legal Team | Templatizing
| Line 9: | Line 9: | ||
* Explanation of the SPDX License List fields: http://spdx.org/spdx-license-list/license-list-overview (at bottom of page) | * Explanation of the SPDX License List fields: http://spdx.org/spdx-license-list/license-list-overview (at bottom of page) | ||
* Description of current proposal and XML tags: http://wiki.spdx.org/view/Legal_Team/Templatizing/tags-matching | * Description of current proposal and XML tags: http://wiki.spdx.org/view/Legal_Team/Templatizing/tags-matching | ||
| + | * Video of review process demonstrated: https://www.youtube.com/watch?v=E_VoRQbDyEc | ||
| − | + | You may also want to watch: | |
| − | + | ||
* Using Git (on Windows): https://www.youtube.com/watch?v=nsSjT4cmVEc -- why/who needs this as pertains to process? | * Using Git (on Windows): https://www.youtube.com/watch?v=nsSjT4cmVEc -- why/who needs this as pertains to process? | ||
| Line 21: | Line 21: | ||
=== Process for Review === | === Process for Review === | ||
# go to https://github.com/spdx/license-list-XML (you need a Github account) | # go to https://github.com/spdx/license-list-XML (you need a Github account) | ||
| + | # | ||
# go to pull requests (this represents all the licenses that need to be reviewed) | # go to pull requests (this represents all the licenses that need to be reviewed) | ||
# pick a license to review ; go to "Files changed" to view the actual file (in diff format) | # pick a license to review ; go to "Files changed" to view the actual file (in diff format) | ||
| Line 33: | Line 34: | ||
* approved = someone looked at it, thinks it's good to go, but didn't merge it | * approved = someone looked at it, thinks it's good to go, but didn't merge it | ||
* has acknowledgement = if you find a license that has acknowledgment text, then label it with "has acknowledgement" - for example see: | * has acknowledgement = if you find a license that has acknowledgment text, then label it with "has acknowledgement" - for example see: | ||
| − | * use ... define these?? | + | * question = use if you have a question generally |
| + | * need legal discussion = there is a question you want to discuss on the next call or with someone else | ||
| + | use ... define these?? | ||
* If you have approved the content, but otherwise approved, use "approved" label | * If you have approved the content, but otherwise approved, use "approved" label | ||
* If the license is good to go, then click on the "merge pull request" and you're done! | * If the license is good to go, then click on the "merge pull request" and you're done! | ||
Revision as of 16:58, 5 May 2016
Plan for review of XML license file
The files can be found here: https://github.com/spdx/license-list-XML
You will need to have a Github account to participate in the review. Let Jilayne know your Github account ID to be added to the repository team.
Key things to review before reviewing the XML files:
- SPDX License List Matching Guidelines: http://spdx.org/spdx-license-list/license-list-overview
- Explanation of the SPDX License List fields: http://spdx.org/spdx-license-list/license-list-overview (at bottom of page)
- Description of current proposal and XML tags: http://wiki.spdx.org/view/Legal_Team/Templatizing/tags-matching
- Video of review process demonstrated: https://www.youtube.com/watch?v=E_VoRQbDyEc
You may also want to watch:
- Using Git (on Windows): https://www.youtube.com/watch?v=nsSjT4cmVEc -- why/who needs this as pertains to process?
Key things to look at during review:
- identify which parts of the license template are important or unimportant for purposes of matching (as per the Matching Guidelines)
- structural components - ensuring we have groups of clauses correctly identified (automated process takes care of most of this, but sanity check). Note that if a license does not have info for certain tags (e.g., Notes or a Standard Header) these tags won't appear in the XML
- consider any changes that need to be made to the Matching Guidelines or License List Overview/description of fields
Process for Review
- go to https://github.com/spdx/license-list-XML (you need a Github account)
- go to pull requests (this represents all the licenses that need to be reviewed)
- pick a license to review ; go to "Files changed" to view the actual file (in diff format)
- if everything looks good, then go back to "conversation" tab and you can either:
- merge the pull request if you feel confidant to do so
- leave a comment that you reviewed it and label this as "approved" - labels are found in the right side (see below for more on labels)
- if you see something you have a question about or think needs editing, then you can:
- if you want to actually edit the content, click on the pencil icon in the top right corner (you will need access to Kris' fork of this account)
- comment in-line
Labels created in Github: https://github.com/spdx/license-list-XML/labels
- approved = someone looked at it, thinks it's good to go, but didn't merge it
- has acknowledgement = if you find a license that has acknowledgment text, then label it with "has acknowledgement" - for example see:
- question = use if you have a question generally
- need legal discussion = there is a question you want to discuss on the next call or with someone else
use ... define these??
- If you have approved the content, but otherwise approved, use "approved" label
- If the license is good to go, then click on the "merge pull request" and you're done!
