crickets-and-comb/shared

Differentiate documentation between `shared` and `reference_package`.

Open

#48 geöffnet am 26. März 2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Makefile (0 Forks)auto 404
documentationhelp wanted

Repository-Metriken

Stars
 (2 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The README docs in the shared repo and the reference_package repo overlap quite a bit. Also, we abandoned updating documentation in reference_package where it pertains to shared procedures etc., so it has gotten stale.

We need to better differentiate the documentation in shared from the documentation in reference_package. The reference_package documentation shouldn't really document how to use the shared Git submodule other than to refer the user to the shared documentation.

See https://github.com/crickets-and-comb/reference_package/issues/21

Contributor Guide

Research-Richtung
Vergleiche die README Dateien in den Repositories 'shared' und 'reference package', um überlappende Inhalte zu identifizieren. Verfeinere dann die 'shared' Dokumentation, um sich auf ihre eigenen Ressourcen zu konzentrieren, und stelle sicher, dass die 'reference package' Dokumentation nur auf 'shared' verweist, ohne Anweisungen zu duplizieren. Siehe reference package Issue #21 für Kontext.
Tech Stack
Keine
Domain
documentation
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.
Aktiv
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.
75