crytic/slither

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

Open

#1,916 opened on May 15, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (4,769 stars)
PR merge metrics
 (Avg merge 54d 9h) (2 merged PRs in 30d)

Description

Describe the desired feature

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

Contributor guide

Research direction
Study how Slither currently parses Solidity source code and existing detectors for documentation. Look at the AST structure for natspec comments. Examine how other detectors are implemented to add a new detector for missing natspec comments.
Tech stack
python
Domain
securityblockchain
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSolidity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80