crytic/slither

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

Open

#1.916 geöffnet am 15. Mai 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (886 Forks)batch import
enhancementgood first issue

Repository-Metriken

Stars
 (4.769 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 54T 9h) (2 gemergte PRs in 30 T)

Beschreibung

Describe the desired feature

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

Contributor Guide

Research-Richtung
Studieren Sie, wie Slither derzeit Solidity Quellcode analysiert und vorhandene Detektoren für Dokumentation. Überprüfen Sie die AST Struktur für Natspec Kommentare. Untersuchen Sie, wie andere Detektoren implementiert sind, um einen neuen Detektor für fehlende Natspec Kommentare hinzuzufügen.
Tech Stack
python
Domain
securityblockchain
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSolidity
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80