Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (42 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.3 KB
Raw

Contributing to TinyML Complete Kit

Language: English · فارسی

Thanks for helping improve this learning kit. Small, focused changes are welcome.

Code of conduct

Please read and follow CODE_OF_CONDUCT.md.

Ways to contribute

  • Fix typos / clarify docs (EN or FA) — keep both languages in sync when you change meaning.
  • Improve scripts under python/ (clarity, Windows CPU path, error messages).
  • Harden firmware templates or industrial project tests.
  • Report bugs with OS, Python version, and exact command + log excerpt.

Prerequisites

  • Python 3.10 or 3.11
  • Windows PowerShell examples are canonical; note Linux/macOS differences in the PR if you change shells.
  • Create a venv and install python/requirements.txt before running labs.

Development workflow

  1. Fork and branch from main (docs/…, fix/…, or feat/…).
  2. Prefer conventional commits: docs:, fix:, feat:, chore:.
  3. Do not commit .venv/, large .keras / .tflite blobs, or secrets.
  4. If you change user-facing behavior, update README.md and README.fa.md (or the linked doc pair).
  5. Open a PR describing why, how you tested, and any hardware assumptions.

Documentation sync

If you change… Also update…
Install / quick start commands README.md, README.fa.md, docs/06-INSTALL-AND-VERIFY*.md
Architecture / ports docs/ARCHITECTURE*.md, monitoring READMEs
Learning path order docs/00-START-HERE*.md, docs/05-Roadmap*.md, docs/DOCUMENTATION-INDEX.md
Security surface SECURITY.md / SECURITY.fa.md

Testing (minimum)

.\.venv\Scripts\Activate.ps1
$env:PYTHONIOENCODING = "utf-8"
python python\tools\check_system.py
# Re-run any script you touched, e.g.:
# python python\01_hello_tinyml_sine.py

For the industrial project, prefer python scripts\run_full_pipeline.py only when your change affects that pipeline (it is long-running).

What we will not merge

  • Fake “100% production-ready plant floor” claims without commissioning evidence.
  • CUDA / GT 610 “required” paths for TinyML.
  • License-incompatible third-party dumps without attribution and license text.

Questions

Open a GitHub Discussion or Issue with the question label.