realpython / realpython/python-guide
Recommend pre-commit in Code Style section
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Batchfile
- Estrelas
- 29.8k
- Forks
- 5.9k
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
The Code Style section discusses the use of PEP8 and autopep8. Yelp's pre-commit framework allows you to formalise the use of PEP8 in a project by ensuring that PEP8/PyFlakes is run on Python code (as well as equivalent tools for other languages like JSHint). Pre-commit is not mandatory: it is something which individual developers on a project can install if they feel like it - the pre-commit framework simply allows you to share around a common set of pre-commit scripts in a sensible way.
If it is desirable to follow "Pythonicity" in a project, it is probably a good idea to suggest people enforce it at the level of version control.
If there's interest in this, I can draft some text for inclusion and submit a PR.
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.
Direção de pesquisa
Comece pela seção Code Style, especialmente pela discussão sobre PEP8 e autopep8, e revise como o guia apresenta atualmente as ferramentas de estilo. Considera-se concluído quando a seção abordar claramente a recomendação proposta para pre-commit e seu caráter opcional, mantendo coerentes as orientações existentes.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100