OpenDevicePartnership / OpenDevicePartnership/OpenDevicePartnership.github.io

Dynamic Repository Diagrams

Ouverte
#60 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Rust
Étoiles
1
Forks
10
Merge moyen
5 j 22 h
PR mergées (30 j)
1

Description

The Projects landing page has 3 main links for P (Patina), EC, and ES (EC Services) which bring up a page with What, Why, Who, and a repository diagram.

This task covers improvements for those diagrams:

  1. Create an engine that auto-generates the diagram each time the user opens the page instead of relying on a user updated jpg. Maybe pull topics from each repo for determining how to use the URLs?
  2. Add text to the auto-generated diagram to explain what it is and how to read it. The text needs to be geared to a new engineer browsing the web site.
  3. Create an action in this repo that creates a bug if any repository is found that does not provide the necessary hooks for the diagram engine.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez la page d’accueil Projects et ses liens vers Patina, EC et EC Services, puis retracez la manière dont les diagrammes actuels des dépôts sont fournis. Définissez le moteur de diagrammes, le texte explicatif destiné aux nouveaux contributeurs et la validation nécessaire des dépôts ; le travail est terminé lorsque les diagrammes sont générés à l’accès à la page et qu’une action automatisée signale les dépôts auxquels il manque les hooks requis.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github-actions, rust
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.