microsoft/vasim

Redo README

Aperta

#8 aperta il 30 ago 2024

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Python (7 fork)auto 404
documentationhelp wanted

Metriche repository

Star
 (12 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Aggiorna il file README con il progetto attuale. Crea o rivedi i diagrammi di sequenza nella cartella docs utilizzando file di testo e sequencediagram.org. Fai riferimento alla vecchia versione interna ma assicurati dell'accuratezza.
Tech stack
python
Dominio
Nessuno
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85