-
Notifications
You must be signed in to change notification settings - Fork 474
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
📖 Update docs on how to run and debug locally #2587
📖 Update docs on how to run and debug locally #2587
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #2587 +/- ##
=======================================
Coverage 41.27% 41.27%
=======================================
Files 123 123
Lines 10043 10043
=======================================
Hits 4145 4145
Misses 5602 5602
Partials 296 296 |
Integration tests success for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Integration tests success for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
d6014ff
to
69f75f1
Compare
Stale pull request message |
69f75f1
to
9056020
Compare
Integration tests success for |
Stale pull request message |
Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
9056020
to
f539969
Compare
Integration tests success for |
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Shofiya2003 <shofiyabootwala@gmail.com>
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Shofiya2003 <shofiyabootwala@gmail.com>
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
Signed-off-by: Gabriela Gutierrez gabigutierrez@google.com
What kind of change does this PR introduce?
Update docs on how to how to run Scorecard locally and debug Go files by logging to console or to an output file.
What is the current behavior?
Currently the docs don't explain how to run Scorecard locally, only how to build it. I added instructions on how to run it locally. The other thing is there are currently no debug instructions. Debugging is more Go language related than Scorecard related but I thought adding some debug instructions would be useful.
What is the new behavior (if this is a feature change)?**
Which issue(s) this PR fixes
None.
Special notes for your reviewer
Does this PR introduce a user-facing change?
For user-facing changes, please add a concise, human-readable release note to
the
release-note
(In particular, describe what changes users might need to make in their
application as a result of this pull request.)