ossf/sbom-everywhere

Create a getting started guide

Open

#68 opened on Aug 23, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Vue (44 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (116 stars)
PR merge metrics
 (PR metrics pending)

Description

We need a guide written that explains for new contributors how to get started. We should write such a guide with the assumption the people adding content are not overly familiar with GitHub, open source, or SBOM Everywhere

If we want to be inclusive we cannot be too descriptive.

Contributor guide

Research direction
Review the project's existing documentation and community guidelines to understand the project's goals and structure, then draft a step by step guide for new contributors assuming minimal prior knowledge of GitHub and open source.
Tech stack
None
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85