Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (21 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.01 KB
Raw

Contributing

Choose a contribution

Look for issues labeled good first issue, documentation, or hardware. If a change alters a pin map, command, or learning objective, open an issue first.

Verify your work

  • Compile every changed sketch for Arduino Uno.
  • Test hardware changes with the exact circuit described in the pull request.
  • Keep loop() responsive; do not add long delay() calls.
  • Update the matching lesson when behavior or wiring changes.
  • Never recommend powering a motor directly from GPIO or the USB 5 V rail.

Install Arduino CLI and run:

arduino-cli core update-index
arduino-cli core install arduino:avr
arduino-cli compile --fqbn arduino:avr:uno exercises/exercise-a-arrow-controller

CI recursively compiles all exercise and extra sketches.

Pull requests

Keep the change focused, explain what a student learns from it, and list the board, core version, power source, and driver used for any hardware test. Participation is governed by the Code of Conduct.