microsoft/vasim

Redo README

Offen

#8 geöffnet am 30.08.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (7 Forks)auto 404
documentationhelp wanted

Repository-Metriken

Stars
 (12 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Update README and design docs. We can use docs folder for seq diagrams and use https://sequencediagram.org for changing them(use txt files). We have an old version of this internally, but if we make it public it would just be misleading because too much changed

Contributor Guide

Research-Richtung
Aktualisieren Sie die README Datei mit dem aktuellen Design. Erstellen oder überarbeiten Sie Sequenzdiagramme im docs Ordner mit Textdateien und sequencediagram.org. Verweisen Sie auf die interne alte Version, aber stellen Sie die Genauigkeit sicher.
Tech Stack
python
Domain
Keine
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
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.
85