crytic/slither

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

Ouverte

#1 916 ouverte le 15 mai 2023

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (886 forks)batch import
enhancementgood first issue

Métriques du dépôt

Stars
 (4 769 étoiles)
Métriques de merge PR
 (Merge moyen 54j 9h) (2 PRs mergées en 30 j)

Description

Describe the desired feature

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

Guide contributeur

Direction de recherche
Étudiez comment Slither analyse actuellement le code source Solidity et les détecteurs existants pour la documentation. Examinez la structure AST pour les commentaires natspec. Examinez comment les autres détecteurs sont implémentés pour ajouter un nouveau détecteur pour les commentaires natspec manquants.
Stack technique
python
Domaine
securityblockchain
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSolidity
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80