Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Sketch bug
description: Report a reproducible sketch or documentation error.
title: "[Bug]: "
labels: ["bug"]
body:
- type: input
id: lesson
attributes:
label: Lesson and sketch
placeholder: Exercise B / exercise-b-multi-led-pattern.ino
validations:
required: true
- type: input
id: environment
attributes:
label: Board and core version
placeholder: Arduino Uno / Arduino AVR Boards 1.8.6
validations:
required: true
- type: textarea
id: circuit
attributes:
label: Circuit and power details
description: For motor exercises, include the driver and supply ratings.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction and observed behavior
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Private security report
url: https://github.com/devkyato/Arduino-Programs-Guide/security/advisories/new
about: Report software vulnerabilities privately.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/lesson.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Lesson improvement
description: Propose a clearer explanation, test, diagram, or challenge.
title: "[Lesson]: "
labels: ["documentation"]
body:
- type: input
id: lesson
attributes:
label: Lesson
validations:
required: true
- type: textarea
id: confusion
attributes:
label: What is unclear or missing?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed improvement
validations:
required: true
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Learning outcome

<!-- What becomes safer, clearer, or more useful for a student? -->

## Verification

- [ ] Changed sketches compile for Arduino Uno
- [ ] Matching lesson documentation is updated
- [ ] No blocking delay was added to interactive behavior
- [ ] Hardware/power details are included when applicable

## Hardware tested

<!-- Board, core, driver, supply, wiring, or "Not hardware-tested". -->
9 changes: 9 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly
groups:
actions:
patterns: ["*"]
37 changes: 37 additions & 0 deletions .github/workflows/compile.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Sketch compilation

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

permissions:
contents: read

jobs:
compile-uno:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: arduino/compile-sketches@v1
with:
fqbn: arduino:avr:uno
libraries: "[]"
sketch-paths: |
- exercises
- extras
enable-warnings-report: true

offline-package:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/setup-python@v7
with:
python-version: "3.14"
- run: python tools/build_release.py
- uses: actions/upload-artifact@v6
with:
name: Arduino-Programs-Guide
path: dist/*.zip
25 changes: 25 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Release

on:
push:
tags: ["v*"]

permissions:
contents: write

jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/setup-python@v7
with:
python-version: "3.14"
- name: Verify tag
shell: bash
run: test "$GITHUB_REF_NAME" = "v$(cat VERSION)"
- run: python tools/build_release.py
- name: Publish release
env:
GH_TOKEN: ${{ github.token }}
run: gh release create "$GITHUB_REF_NAME" dist/*.zip --generate-notes --verify-tag
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.vscode/
build/
dist/
*.hex
*.elf
*.bin
*.map
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Changelog

## [1.0.0] - 2026-07-29

- Turn the sketch collection into a six-lesson learning path.
- Add wiring, safety, serial-control, troubleshooting, and lesson documentation.
- Refactor every sketch to remain responsive without blocking pattern delays.
- Add official Arduino Uno compilation checks and contributor templates.

[1.0.0]: https://github.com/devkyato/Arduino-Programs-Guide/releases/tag/v1.0.0
13 changes: 13 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Code of Conduct

This project is a learning space. Be patient, specific, and constructive. Welcome
beginner questions, explain corrections without ridicule, and respect different
backgrounds and experience levels.

Harassment, discriminatory language, personal attacks, and publishing private
information are not acceptable. Report problems privately through the
maintainer's GitHub profile. Maintainers may remove content or restrict
participation to protect the community.

This policy is adapted from the
[Contributor Covenant 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 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:

```sh
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](CODE_OF_CONDUCT.md).
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 devkyato

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading