crickets-and-comb/shared

Differentiate documentation between `shared` and `reference_package`.

Open

#48 ouverte le 26 mars 2025

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Makefile (0 forks)auto 404
documentationhelp wanted

Métriques du dépôt

Stars
 (2 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Comparez les fichiers README dans les dépôts 'shared' et 'reference package' pour identifier le contenu qui se chevauche. Ensuite, affinez la documentation 'shared' pour se concentrer sur ses propres ressources et assurez vous que la documentation 'reference package' ne fasse que référence à 'shared' sans dupliquer les instructions. Référez vous à l'issue #21 de reference package pour le contexte.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75