Pico Lüfter-Hub Software

[Exellent1988]

Description

This PR introduces a comprehensive CI/CD pipeline using GitHub Actions for the Pico Fan Hub project and initiates the translation of core documentation and GitHub community files to English.

Key Changes:

• GitHub Actions Workflows:
  • ci.yml: Orchestrates firmware build and Python tests.
  • firmware-build.yml: Builds Raspberry Pi Pico firmware (.uf2, .elf, .bin) with SDK caching and version extraction.
  • python-tests.yml: Performs linting (flake8, black, mypy), runs unit tests (pytest, coverage), and builds Python packages (.whl, .tar.gz) across multiple Python versions.
  • release.yml: Automates GitHub Releases upon tag pushes, uploading all firmware and Python artifacts and generating release notes.
  • .github/workflows/README.md: Provides detailed documentation for all CI/CD workflows.
• Project Configuration & Community Files:
  • .github/dependabot.yml: Configures Dependabot for automated dependency updates for GitHub Actions and Python.
  • .github/pull_request_template.md: Adds a PR template for consistent contributions.
  • .github/ISSUE_TEMPLATE/: Adds templates for bug reports and feature requests.
  • .github/CODE_OF_CONDUCT.md: Implements a Code of Conduct.
  • .editorconfig: Ensures consistent code formatting across the project.
  • README.md: Updated with CI/CD status badges.
• Internationalization (i18n):
  • Initial translation of README.md, CONTRIBUTING.md, CHANGELOG.md, and GitHub community templates to English.
  • .translation-status.md: A new document to track the progress of further translations.

Type of Change

• 🐛 Bug fix (non-breaking change that fixes an issue)
• ✨ New feature (non-breaking change that adds functionality)
• 💥 Breaking change (fix or feature that changes existing functionality)
• 📚 Documentation (documentation changes only)
• 🔧 Maintenance (dependency updates, refactoring, etc.)

Affected Components

• Firmware (Raspberry Pi Pico) - Build process affected
• Python software (driver/CLI) - Build and test process affected
• Hardware design (KiCad/schematic)
• Documentation
• CI/CD (GitHub Actions)

How Has This Been Tested?

• Firmware compiles without errors (via GitHub Actions workflow)
• Python tests pass (via GitHub Actions workflow, linting and package build confirmed)
• Manual testing performed (verified GitHub Actions workflow runs and artifact generation, confirmed documentation readability)
• Hardware tested (if relevant)

Test Configuration:

• Hardware: GitHub Actions runners
• OS: Ubuntu Latest
• Python version: 3.8, 3.9, 3.10, 3.11

Checklist

• Code follows project style (enforced by .editorconfig and Python linting in CI)
• Self-review performed
• Comments added for hard-to-understand areas (existing comments translated)
• Documentation updated (new CI/CD docs, translated core docs)
• No new warnings when compiling (checked by firmware build CI)
• Tests added (CI/CD workflows for testing are added, actual unit test files are a follow-up)
• All tests pass locally (CI/CD workflows pass)
• CI/CD checks pass

Screenshots/Logs

• CI/CD badges added to README.md reflecting workflow status.
• Detailed logs available in GitHub Actions runs for firmware build, Python tests, and release creation.

Additional Notes

This PR lays the groundwork for robust continuous integration and delivery, making the project more maintainable and accessible for international collaboration. Further translation efforts are tracked in .translation-status.md.

Related Issues

Closes #

---

 

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}