pySCG: investigate and recommend a list of static code analysis tools
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- python
- Domínio
- documentation, security, testing
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- Python
- Estrelas
- 2
- Forks
- 2
- Merge médio
- 11min
- PRs com merge (30d)
- 2
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de ossf/python-secure-coding-guide
-
pyscg-0051 should use a context managerTalvez já em andamento @s19110 assumiu há 8 dias. Abertabug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
ossf/python-secure-coding-guide#1 · 4 comentários · 1 responsável ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 65/100
ossf/python-secure-coding-guide#29 · 1 comentário ·
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 25/100
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 25/100
Todas as issues de ossf/python-secure-coding-guide
Issues semelhantes
-
documentation type/bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
add entry to blockAberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 65/100
StevenBlack/hosts#3299 ·
-
`garak --report` overwrites the input report when its name has no ".report"Talvez já em andamento @0z5a assumiu hoje. Abertaneeds-triage
Dificuldade 2/5 Meio dia Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 2 dias
-
trace: Pi's 1-hour cache writes are priced at 1.25x, but billed at 2xTalvez já em andamento @Shizoqua assumiu hoje. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
microsoft/TokenEconomizer#221 ·
Mantenedores costumam responder em até 1 dia
-
plot_graph crashes when a mesh node has no m2m edgeTalvez já em andamento @tygvi assumiu hoje. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
mllam/neural-lam#883 · 1 comentário ·
Mantenedores costumam responder em até 2 dias