pySCG: investigate and recommend a list of static code analysis tools

Đang mở
#10 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python

Hướng nghiên cứu

Read the contribution guide and its existing mention of Ruff with Bandit, then check the related type hints topic for overlap. Draft a page recommending static and dynamic analysis tools and a minimum tool set for Python coding environments. Done means the guidance covers the listed tool examples and avoids duplicating the type hints topic.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

automated detection of well known code flaws and a common way of formatting can be very helpfull to avoid issues.

This issue is as a placeholder to create a page explaining static code analysis tools as mentioned in our contribution guide (Ruff with configured Bandit) and dynamic analysis tools such as pyre.

It might be required to merge it with the topic on type hints to avoid duplication. We should however provide some sort of solid idea of bare minimum that should be included in every coding ide similar to Compiler Options Hardening Guide for C and C++

Example Static tools:

  • Ruff
  • Pylint
  • Mypy
  • Bandit
  • PyDocstyle
  • Mccabe
  • Vulture
  • SonarQube
  • pep8
  • flake8

Example dynamic tools:

  • PyTest
  • Pytest-cov
  • coverage.py

Test automation:

  • Tox
Ngôn ngữ chính
Python
Star
2
Fork
2
Merge trung bình
11 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ossf/python-secure-coding-guide

Tất cả issue của ossf/python-secure-coding-guide

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.