crytic/slither

[Bug-Candidate]: Wiki "Configuration File" section missing supported flags

Ouverte

#1 155 ouverte le 3 avr. 2022

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Python (886 forks)batch import
documentationenhancementgood first issuehelp wanted

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 issue:

The list of configuration file options is incomplete

Code example to reproduce the issue:

The config file options in the wiki are here: https://github.com/crytic/slither/wiki/Usage#configuration-file

The supported options in the code are here: https://github.com/crytic/slither/blob/8344524cd35a1edf37c1cc791eb08c8ffff645a8/slither/utils/command_line.py#L26-L51

Some examples of supported config options not in the wiki are "exclude_dependencies", "exclude_optimization", and "sarif".

Version:

0.8.2

Relevant log output:

No response

Guide contributeur

Direction de recherche
Consultez la page Wiki à l'adresse https://github.com/crytic/slither/wiki/Usage#configuration file et comparez la avec les options prises en charge dans https://github.com/crytic/slither/blob/8344524cd35a1edf37c1cc791eb08c8ffff645a8/slither/utils/command line.py#L26 L51. Ajoutez les options manquantes telles que 'exclude dependencies', 'exclude optimization' et 'sarif' au wiki. Assurez vous que toutes les autres options sont correctement listées.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90