chakra-core/ChakraCore

Documenting ChakraCore's internals

Open

#6414 aperta il 11 apr 2020

Vedi su GitHub
 (1 commento) (4 reazioni) (0 assegnatari)JavaScript (1374 fork)batch import
Codebase QualityTaskhelp wanted

Metriche repository

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

Descrizione

As part of improving the experience for contributors we should produce helpful documentation covering the logic of ChakraCore's internals. Including what the key data types are in each area and what key logical processes are used internally:

It would be good if multiple people could contribute to this, we'll need to think about exactly how it should all hang together but here's a rough list of the things we should document:

  • Process overview from script file -> execution with notes on where different aspects of the codebase are involved
  • Parser
  • Bytecode emitter
  • Type system
  • Interpretor
  • JS Library
  • JsBuiltins
  • INTL
  • GarbageCollector/Recycler
  • Jit
  • Internal Data Structures
  • RegEx parsing and matching

Guida contributor

Direzione di ricerca
Scegli un'area specifica dall'elenco, studia il codice sorgente corrispondente e scrivi una documentazione chiara che spieghi le strutture dati e i processi chiave.
Tech stack
javascript
Dominio
developer experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
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.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70