ossf/sbom-everywhere

Create a getting started guide

Offen

#68 geöffnet am 23.08.2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Vue (44 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (116 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Überprüfen Sie die vorhandene Dokumentation und die Community Richtlinien des Projekts, um die Ziele und die Struktur des Projekts zu verstehen, und erstellen Sie dann eine Schritt für Schritt Anleitung für neue Mitwirkende, die davon ausgeht, dass sie nur minimale Kenntnisse über GitHub und Open Source haben.
Tech Stack
Keine
Domain
documentationdeveloper experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85