Skip to content

Conversation

@deivid-rodriguez
Copy link
Contributor

When print options, there are two sections: "Scorecard options:" and "Event / repo information:". However, the headers of these sections have the same format as the options themselves (name followed by ":"). So I initially failed to identify they were just headers, and thought they were actual options that were empty.

I think indenting entries inside each section helps avoid this confusion.

Before:

Scorecard options:
Ref: HEAD
Repository: ossf/scorecard
Local:
Format: sarif
Policy file: /policy.yml

Event / repo information:
Event file: /testdata/fork.json
Event name: branch_protection_rule
Fork repository: true
Private repository: true
Publication enabled: false
Default branch: main

After:

Scorecard options:
  Ref: HEAD
  Repository: ossf/scorecard
  Local:
  Format: sarif
  Policy file: /policy.yml

Event / repo information:
  Event file: /testdata/fork.json
  Event name: branch_protection_rule
  Fork repository: true
  Private repository: true
  Publication enabled: false
  Default branch: main

When print options, there are two sections: "Scorecard options:" and
"Event / repo information:". However, the headers of these sections have
the same format as the options themselves (name followed by ":"). So I
initially failed to identify they were just headers, and thought they
were actual options that were empty.

I think indenting entries inside each section helps avoid this
confusion.

Before:

```console
Scorecard options:
Ref: HEAD
Repository: ossf/scorecard
Local:
Format: sarif
Policy file: /policy.yml

Event / repo information:
Event file: /testdata/fork.json
Event name: branch_protection_rule
Fork repository: true
Private repository: true
Publication enabled: false
Default branch: main
```

After:

```console
Scorecard options:
  Ref: HEAD
  Repository: ossf/scorecard
  Local:
  Format: sarif
  Policy file: /policy.yml

Event / repo information:
  Event file: /testdata/fork.json
  Event name: branch_protection_rule
  Fork repository: true
  Private repository: true
  Publication enabled: false
  Default branch: main
```

Signed-off-by: David Rodríguez <[email protected]>
Copy link
Member

@spencerschrock spencerschrock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants