Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Enhance the tech_review hook

Abierto
#282 1 comentario 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
tooling

Línea de trabajo

Comienza revisando el hook tech_review existente y cómo selecciona los archivos y directorios de Python. Lee la documentación de docstring_parser y, después, determina si la validación debe estar en tech_review o en un hook nuevo; se considera terminado cuando se hayan analizado los docstrings de las funciones y clases seleccionadas y se informen los casos que no cumplan los requisitos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement
📝 Description of the feature

Use the docstring parser to check docstrings in repositories are valid/compliant as suggested by @AlejandroFernandezLuces

Perhaps we can make this a new hook or add it to the tech_review hook

💡 Steps for implementing the feature
  • Look through each python file in certain directories & parse the docstrings in each function and/or class
🔗 Useful links and references

docstring parser

Lenguaje dominante
Python
Estrellas
5
Forks
1
Merge medio
1 h 36 min
PR fusionados (30 d)
7

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ansys/pre-commit-hooks

Todos los issues de ansys/pre-commit-hooks

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.