Document DeltaCode output format fields/structure

aboutcode-org / deltacode

DeltaCode: compare two codebase scans (from ScanCode) to detect significant changes.

http://www.aboutcode.org/

20 stars 27 forks source link

Closed steven-esser closed 6 years ago

johnmhoran commented 6 years ago

@majurg I've added a new wiki page for this issue #93 -- "DeltaCode Output: Format, Fields and Structure". Available for your review and feedback at https://github.com/nexB/deltacode/wiki/DeltaCode-Output:-Format,-Fields-and-Structure.

steven-esser commented 6 years ago

@johnmhoran This doc looks good.

One modification that I think we should make after looking at this document:

for the deltacode options field, I think we should be consistent with our 'key' names here and have these key names be the actual option names as they appear in the --help text.

So for us that would be --new and --old

steven-esser commented 6 years ago

Once those changes are made in the code, you can open a PR and this should be ready to go.

johnmhoran commented 6 years ago

Will do @majurg .

johnmhoran commented 6 years ago

@majurg Also modified the new wiki page accordingly.