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

未關閉
#10 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
45/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
冷清
技術堆疊
python

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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
主要語言
Python
星號
2
分支
2
平均合併
11 分鐘
30 天內合併 PR
2

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

ossf/python-secure-coding-guide 的其他 Issue

查看 ossf/python-secure-coding-guide 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。