life-itself/web3

Rework root README.md now that site is launched

Open

#74 aperta il 18 mar 2022

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)HTML (218 fork)batch import
good first issue

Metriche repository

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

Descrizione

README.md at root of repo is what people currently see arriving here. We should probably revise it given that a) we now have the main site b) it is now the contribute path for devs

Suggest:

  • Move current README content into e.g. notes as awesome-crypto-critique or similar (easiest)
    • Someday we can move all the library items into the library and then build the page off that but until then ... this is KISS
  • Revise README with brief intro to project and instructions for devs and others (and perhaps a pointer to old awesome-cryto-critique content for people who arrive at github repo looking for that - we still have quite a few links on twitter etc to it)

Guida contributor

Direzione di ricerca
L'attuale README.md dovrebbe essere rivisto per riflettere il lancio del sito principale. Spostare i contenuti esistenti in un file separato come 'awesome crypto critique.md' per la conservazione. Quindi riscrivere il README.md nella directory root con una breve introduzione al progetto, le istruzioni per i contributi degli sviluppatori e un riferimento ai contenuti precedenti per gli utenti che arrivano tramite link di Twitter. Rivedere i commenti dell'issue per eventuali contesti aggiuntivi.
Tech stack
Nessuno
Dominio
documentation
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
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85