crytic/slither

Parse natspec comments for functions, events, errors, state variables

Open

#1916 aperta il 15 mag 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (886 fork)batch import
enhancementgood first issue

Metriche repository

Star
 (4769 star)
Metriche merge PR
 (Merge medio 54g 9h) (2 PR mergiate in 30 g)

Descrizione

Describe the desired feature

Want to build a detector to detect if natspec comments are missing.

Guida contributor

Direzione di ricerca
Studia come Slither analizza attualmente il codice sorgente Solidity e i rilevatori esistenti per la documentazione. Esamina la struttura AST per i commenti natspec. Esamina come sono implementati altri rilevatori per aggiungere un nuovo rilevatore per i commenti natspec mancanti.
Tech stack
python
Dominio
securityblockchain
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSolidity
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80