Curation guideline

This information is intended to provide guidelines on how data are curated for the OSSelot project and how contributing works. The curator should be familiar with their preferred scanning tool (ours is Fossology) and have a general understanding of copyright law and in particular knowledge of FOSS licensing.

Note: Whenever information is given that is specific to Fossology, it is prepended with the keyword fossy.

Preparation

• Obtain the component in source code form.
  • Note the download URL.
• Naming convention:
  • Try to follow the project’s naming and version convention, e.g. as given by the release’s git tag.
  • If this is not consistent, use only lowercase letters.
  • [package name]-[version number], e.g. angular-15.1.0.
• Analyze the component with a license scan tool (e.g. Fossology, Scancode).
  • fossy: Fossology default settings for analysis:
    • 7. Select optional analysis:
      • Upload from file
      • Copyright/Email/URL/Author Analysis
      • Monk License Analysis, scanning for licenses performing a text comparison
      • Nomos License Analysis, scanning for licenses using regular expressions
      • Ojo License Analysis, scanning for licenses using SPDX-License-Identifier
    • 10. ScanCode Toolkit, scan for
      • License
      • Copyright
  • Scancode default options for analysis:

    scancode -cli --license-text –json [package name-version].json [package]
    

    c: copyrights; l: licenses; i: file information; --license-text: include full license text