sourcecred/sourcecred

Weight Config UI: look into replacing a/b with node type descriptors

Open

#3120 aperta il 13 ago 2021

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)JavaScript (165 fork)batch import
good first issue

Metriche repository

Star
 (488 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

The "a authors b" and "a is authored b" on the weight configuration page does a poor job of communicating the critical info needed to reason about the edge configs: which two node types are being connected and in which direction. I think it would be a much better UI if it was more like "author -> message" and "message -> author"

A very simple implementation would repurpose the forwardName and backwardName properties in EdgeType to represent the forward and backward node types (nouns instead of verbs). This would require updating all plugin declarations and refactoring the EdgeTypeConfig react component to output the new UX format.

Guida contributor

Direzione di ricerca
Ispeziona il componente React EdgeTypeConfig e le proprietà forwardName/backwardName in EdgeType. Identifica tutte le dichiarazioni dei plugin che usano il formato a/b e pianifica la sostituzione con descrittori di tipo nodo come 'author > message' e 'message > author'.
Tech stack
javascriptreact
Dominio
frontendfull stack
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
ReactJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65