Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Suggest possible GitHub remotes when using --local #2059

Open
raghavkaul opened this issue Jul 14, 2022 · 4 comments
Open

Feature: Suggest possible GitHub remotes when using --local #2059

raghavkaul opened this issue Jul 14, 2022 · 4 comments
Labels
kind/enhancement New feature or request Stale

Comments

@raghavkaul
Copy link
Contributor

Is your feature request related to a problem? Please describe.
As a maintainer, when cloning a GitHub repo and running scorecard against it using the flag --local=., several checks that are only possible on the GitHub repo are skipped. However, I would still like to get information about an 'all-inclusive' score, using both local and remote info.

This would be helpful particularly when working on a branch (i.e. one that intends to improve the overall scorecard score) that hasn't been pushed upstream. As a maintainer, I could see the overall score for my repo, and how my local changes would improve or worsen that score.

In cases where the local and remote contents/score of a repo differ substantially, scorecard should intelligently choose one to take precedence over the other.

Describe the solution you'd like
Scorecard could use .git/config to get information about a repo's GitHub remotes, and suggest them to the user to get a more holistic score when using the --local option.

Describe alternatives you've considered

  • Scorecard could automatically pick a remote on the user's behalf instead of presenting them with the option, but users may want to augment their local scores with either a fork, or with the upstream
  • Scorecard could allow both the--local and --repo options to be specified at the same time, but this could introduce engineering complexity, since for some checks, it's not clear which would take precedence.
@raghavkaul raghavkaul added the kind/enhancement New feature or request label Jul 14, 2022
@azeemshaikh38
Copy link
Contributor

See #1709. We could use go-git here to get any git-related context for local repos. Would be a helpful improvement to the tool if you'd like to tackle this.

@github-actions
Copy link

This issue is stale because it has been open for 60 days with no activity.

Copy link

This issue is stale because it has been open for 60 days with no activity.

Copy link

github-actions bot commented May 4, 2024

This issue has been marked stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the Stale label May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request Stale
Projects
Status: No status
Development

No branches or pull requests

3 participants