Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (26 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

30 lines (26 loc) · 1.74 KB
Raw

Contributing to the MicroPythonOS fork of lvgl_micropython

Open pull requests against the integration branch (the default branch), not main. main stays close to the upstream lvgl_micropython layout; integration is the curated branch that aggregates the MicroPythonOS-specific deltas and is what MicroPythonOS builds consume.

Conventions:

  • Branch names: feat/<name> or fix/<name> for focused changes; long-running work lives on topic/<name> branches (see the "MicroPythonOS Branching Model" section in the README for the current list and the merge flow).
  • Build-time patches: changes that MicroPythonOS applies at build time (to lib/micropython, lib/lvgl, or this repo's own files such as builder/) are committed as .patch files in the repo root and applied by MicroPythonOS's scripts/build_mpos.sh — add the .patch here and open a companion PR there. The mechanism, the current list, and the add/update/verify workflow are documented once in the MicroPythonOS docs: Build-time Patches.
  • Custom fonts: regenerate via lib_lvgl_src_font/regenerate_fonts.sh (see lib_lvgl_src_font/README.md); don't hand-edit generated .c files.
  • main changes: only cross-cutting documentation belongs there; everything else goes to integration or a topic branch.

Building and testing happens through the MicroPythonOS super-repo (scripts/build_mpos.sh), which pins this repository as a submodule — see its docs for desktop/device build instructions. Heed the warning at the top of this repo's README about submodule handling when cloning standalone.