Skip to content

Commit a4c2760

Browse files
devkyatodevkyato
authored
Merge pull request #1: publish Arduino Programs Guide v1.0.0
Official Arduino Uno compilation and offline package checks passed.
2 parents c78b192 + 41d615a commit a4c2760

40 files changed

Lines changed: 1286 additions & 662 deletions

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Sketch bug
2+
description: Report a reproducible sketch or documentation error.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: input
7+
id: lesson
8+
attributes:
9+
label: Lesson and sketch
10+
placeholder: Exercise B / exercise-b-multi-led-pattern.ino
11+
validations:
12+
required: true
13+
- type: input
14+
id: environment
15+
attributes:
16+
label: Board and core version
17+
placeholder: Arduino Uno / Arduino AVR Boards 1.8.6
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: circuit
22+
attributes:
23+
label: Circuit and power details
24+
description: For motor exercises, include the driver and supply ratings.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: reproduction
29+
attributes:
30+
label: Reproduction and observed behavior
31+
validations:
32+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Private security report
4+
url: https://github.com/devkyato/Arduino-Programs-Guide/security/advisories/new
5+
about: Report software vulnerabilities privately.

‎.github/ISSUE_TEMPLATE/lesson.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Lesson improvement
2+
description: Propose a clearer explanation, test, diagram, or challenge.
3+
title: "[Lesson]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: input
7+
id: lesson
8+
attributes:
9+
label: Lesson
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: confusion
14+
attributes:
15+
label: What is unclear or missing?
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: proposal
20+
attributes:
21+
label: Proposed improvement
22+
validations:
23+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Learning outcome
2+
3+
<!-- What becomes safer, clearer, or more useful for a student? -->
4+
5+
## Verification
6+
7+
- [ ] Changed sketches compile for Arduino Uno
8+
- [ ] Matching lesson documentation is updated
9+
- [ ] No blocking delay was added to interactive behavior
10+
- [ ] Hardware/power details are included when applicable
11+
12+
## Hardware tested
13+
14+
<!-- Board, core, driver, supply, wiring, or "Not hardware-tested". -->

‎.github/dependabot.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: monthly
7+
groups:
8+
actions:
9+
patterns: ["*"]

‎.github/workflows/compile.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Sketch compilation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
compile-uno:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v7
17+
- uses: arduino/compile-sketches@v1
18+
with:
19+
fqbn: arduino:avr:uno
20+
libraries: "[]"
21+
sketch-paths: |
22+
- exercises
23+
- extras
24+
enable-warnings-report: true
25+
26+
offline-package:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- uses: actions/checkout@v7
30+
- uses: actions/setup-python@v7
31+
with:
32+
python-version: "3.14"
33+
- run: python tools/build_release.py
34+
- uses: actions/upload-artifact@v6
35+
with:
36+
name: Arduino-Programs-Guide
37+
path: dist/*.zip

‎.github/workflows/release.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags: ["v*"]
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
release:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v7
15+
- uses: actions/setup-python@v7
16+
with:
17+
python-version: "3.14"
18+
- name: Verify tag
19+
shell: bash
20+
run: test "$GITHUB_REF_NAME" = "v$(cat VERSION)"
21+
- run: python tools/build_release.py
22+
- name: Publish release
23+
env:
24+
GH_TOKEN: ${{ github.token }}
25+
run: gh release create "$GITHUB_REF_NAME" dist/*.zip --generate-notes --verify-tag

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.vscode/
2+
build/
3+
dist/
4+
*.hex
5+
*.elf
6+
*.bin
7+
*.map

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
## [1.0.0] - 2026-07-29
4+
5+
- Turn the sketch collection into a six-lesson learning path.
6+
- Add wiring, safety, serial-control, troubleshooting, and lesson documentation.
7+
- Refactor every sketch to remain responsive without blocking pattern delays.
8+
- Add official Arduino Uno compilation checks and contributor templates.
9+
10+
[1.0.0]: https://github.com/devkyato/Arduino-Programs-Guide/releases/tag/v1.0.0

‎CODE_OF_CONDUCT.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Code of Conduct
2+
3+
This project is a learning space. Be patient, specific, and constructive. Welcome
4+
beginner questions, explain corrections without ridicule, and respect different
5+
backgrounds and experience levels.
6+
7+
Harassment, discriminatory language, personal attacks, and publishing private
8+
information are not acceptable. Report problems privately through the
9+
maintainer's GitHub profile. Maintainers may remove content or restrict
10+
participation to protect the community.
11+
12+
This policy is adapted from the
13+
[Contributor Covenant 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).

0 commit comments

Comments
 (0)