crytic/slither

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

Open

#1.916 aberto em 15 de mai. de 2023

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issue

Métricas do repositório

Stars
 (4.769 stars)
Métricas de merge de PR
 (Mesclagem média 54d 9h) (2 fundiu PRs em 30d)

Description

Describe the desired feature

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

Guia do colaborador

Direção de pesquisa
Estude como o Slither atualmente analisa o código fonte Solidity e os detectores existentes para documentação. Veja a estrutura AST para comentários natspec. Examine como outros detectores são implementados para adicionar um novo detector para comentários natspec ausentes.
Pilha de tecnologia
python
Domain
securityblockchain
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSolidity
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80