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

Document and clean up VehicleSpecification

Aperta Adatta ai principianti
  • Qualcosa non va?
#129 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 9 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
autonomous-driving, documentation

Direzione di ricerca

Inizia da src/components/vehicle/vehicle_specification.py ed esamina gli argomenti di VehicleSpecification e i calcoli derivati delle dimensioni. Documenta ogni argomento con la relativa unità, chiarisci le costanti senza spiegazione o rendile parametrizzabili, usa None come valore predefinito per i limiti mutabili e rinomina area_size in modo che includa la sua unità. Il lavoro è completato quando le unità e i valori predefiniti documentati corrispondono all’implementazione e le istanze separate non condividono oggetti limite mutabili.

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

Descrizione

good first issue refactoring

Problem

In src/components/vehicle/vehicle_specification.py:

  • Derived sizes use unexplained constants: f_edge_m = f_len_m + 0.5, tread_m = 0.25 * (1.0 + f_len_m + r_len_m), width_m = 1.0 * tread_m
  • x_lim=MinMax(-30, 30) and y_lim=MinMax(-30, 30) are default arguments evaluated once, so all instances share the same objects
  • area_size has no unit in its name, and axle_half_m is not documented

Expected fix

Name and explain the constants (or make them parameters with documented defaults), use None defaults for mutable arguments, rename area_size with a unit suffix, and document every argument with its unit.

Lingua principale
Python
Stelle
1.9k
Fork
313
Merge medio
9g 10h
PR unite (30g)
7

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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 ShisatoYano/AutonomousVehicleControlBeginnersGuide

Tutte le issue di ShisatoYano/AutonomousVehicleControlBeginnersGuide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.