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

📖 Added beginner's guide to scorecard checks docs #3617

Merged
merged 14 commits into from
Nov 29, 2023

Conversation

ariathaker
Copy link
Contributor

-Also edited README to link to the beginner's guide

What kind of change does this PR introduce?

Docs update

What is the current behavior?

N/A

What is the new behavior (if this is a feature change)?**

N/A

Which issue(s) this PR fixes

Addresses issue #3434 --Docs addition: getting started guide.

Special notes for your reviewer

N/A

Does this PR introduce a user-facing change?

NONE

docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
Copy link
Contributor

@olivekl olivekl left a comment

Choose a reason for hiding this comment

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

Thank you for this fantastic guide, @ariathaker! Left some comments for clarity / tone, but overall LGTM --- this will be a great resource for maintainers new to this area.

docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
Copy link

This pull request is stale because it has been open for 10 days with no activity

@github-actions github-actions bot added the Stale label Nov 12, 2023
@olivekl
Copy link
Contributor

olivekl commented Nov 13, 2023

Thanks for the updates, @ariathaker! It looks like you'll need to sign a DCO to get this merged.

@spencerschrock What're the next steps for review here?

@github-actions github-actions bot removed the Stale label Nov 14, 2023
ariathaker and others added 9 commits November 15, 2023 00:59
-Edited README to link to the beginner's guide

Signed-off-by: ariathaker <ariathaker@gmail.com>
Incorporating Spencer's edits.

Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Signed-off-by: ariathaker <ariathaker@gmail.com>
@ariathaker
Copy link
Contributor Author

Ah, thanks @olivekl! I just rebased to include the signature.

@spencerschrock
Copy link
Member

Thanks for the updates, @ariathaker! It looks like you'll need to sign a DCO to get this merged.

@spencerschrock What're the next steps for review here?

I'll take a look again tomorrow 👀.

docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Show resolved Hide resolved
docs/beginner-checks.md Show resolved Hide resolved
@spencerschrock
Copy link
Member

spencerschrock commented Nov 15, 2023

You should also change the PR from draft to "ready for review" (I can also hit this button, but as a maintainer it helps know when the author thinks the PR is ready for review)

Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
@ariathaker ariathaker marked this pull request as ready for review November 16, 2023 04:51
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
Copy link
Contributor Author

@ariathaker ariathaker left a comment

Choose a reason for hiding this comment

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

Very sorry, I didn't realize the "Pending" badge meant that my comments and changes weren't visible! Submitting them all now

docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
docs/beginner-checks.md Show resolved Hide resolved
docs/beginner-checks.md Show resolved Hide resolved
docs/beginner-checks.md Outdated Show resolved Hide resolved
Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
@spencerschrock
Copy link
Member

Very sorry, I didn't realize the "Pending" badge meant that my comments and changes weren't visible! Submitting them all now

It's happened to me before too. In my experience, it depends on which screen you use to leave the comments.

Signed-off-by: ariathaker <51683211+ariathaker@users.noreply.github.com>
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!

Copy link

codecov bot commented Nov 29, 2023

Codecov Report

Merging #3617 (06ff816) into main (0e7e58a) will decrease coverage by 7.68%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3617      +/-   ##
==========================================
- Coverage   76.31%   68.63%   -7.68%     
==========================================
  Files         210      210              
  Lines       14371    14371              
==========================================
- Hits        10967     9864    -1103     
- Misses       2757     3934    +1177     
+ Partials      647      573      -74     

@spencerschrock spencerschrock merged commit ce0b54e into ossf:main Nov 29, 2023
38 checks passed
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.

4 participants