Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Enhance the tech_review hook

Aperta
#282 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
tooling

Direzione di ricerca

Inizia esaminando l'hook tech_review esistente e il modo in cui seleziona i file e le directory Python. Leggi la documentazione di docstring_parser, quindi stabilisci se la validazione debba risiedere in tech_review o in un nuovo hook; il lavoro è completato quando i docstring delle funzioni e delle classi selezionate sono stati analizzati e i casi non conformi vengono segnalati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Python
Stelle
5
Fork
1
Merge medio
1h 47m
PR unite (30g)
7

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ansys/pre-commit-hooks

Tutte le issue di ansys/pre-commit-hooks

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.