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

Docs addition: getting started guide #3434

Closed
olivekl opened this issue Aug 29, 2023 · 5 comments
Closed

Docs addition: getting started guide #3434

olivekl opened this issue Aug 29, 2023 · 5 comments
Assignees
Labels
kind/docs Improvements or additions to documentation kind/enhancement New feature or request Stale

Comments

@olivekl
Copy link
Contributor

olivekl commented Aug 29, 2023

Scorecard is becoming a central starting point for developers new to supply chain security who want to learn how to improve their projects, but the docs don’t have a resource for people who land here and don’t know where to start to understand the basic concepts about why Scorecard exists.

I’d propose a “New to Supply Chain Security? Start Here!” type of guide that could have its own page, pointing maintainers to the checks they may way to prioritize first:

  • Brief intro to supply chain risks generally as applied to open source developers
  • Three sections talking about the general development workflow for open source and how to protect against common risks
    • Setting up your project / contributing to your own source code
    • Accepting PRs / contributions / adding dependencies
    • Releasing

These sections would be written in a casual, conversational tone and would explain why we suggest starting with the following checks:

  • Branch protection
  • Code Review
  • CI Tests
  • Token Permissions
  • Vulnerabilities
  • Dependency Update Tools
  • Packaging

@ariathaker has offered to take on writing this page with me; @pnacht has already provided SME guidance. If there's support for adding this page, we'll get right to work!

@olivekl olivekl added the kind/enhancement New feature or request label Aug 29, 2023
@olivekl olivekl self-assigned this Aug 29, 2023
@spencerschrock spencerschrock added the kind/docs Improvements or additions to documentation label Aug 29, 2023
@spencerschrock
Copy link
Member

Sounds good to me

@github-actions
Copy link

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

@justaugustus
Copy link
Member

Guide is being worked on in #3617.

Copy link

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

@github-actions github-actions bot added the Stale label Dec 30, 2023
@spencerschrock
Copy link
Member

Fixed by #3617

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Improvements or additions to documentation kind/enhancement New feature or request Stale
Projects
None yet
Development

No branches or pull requests

3 participants