Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Document and clean up VehicleSpecification

オープン 初心者向け
#129 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 9 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
リファクタリング
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python

調査の方向性

まず src/components/vehicle/vehicle_specification.py を確認し、VehicleSpecification の引数と、そこから導出されるサイズの計算を調べます。各引数の単位を文書化し、説明のない定数を明確にするかパラメーター化し、変更可能な上限にはデフォルト値として None を使い、area_size は単位を含む名前に変更します。文書化された単位とデフォルト値が実装と一致し、別々のインスタンスが変更可能な上限オブジェクトを共有しなくなれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
1.9k
フォーク
313
平均マージ
9日 10時間
マージ済み PR(30日)
7

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ShisatoYano/AutonomousVehicleControlBeginnersGuide のほかの issue

ShisatoYano/AutonomousVehicleControlBeginnersGuide の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。