Skip to content

repo-layout: define native (C) modules - #90

Merged
bdbarnett merged 1 commit into
mainfrom
docs/native-modules
Oct 29, 2026
Merged

bdbarnett merged 1 commit into
mainfrom
docs/native-modules

Conversation

@bdbarnett

Copy link
Copy Markdown
Contributor

Adds a Native (C) modules section to docs/repo-layout.md: the files every C module has (manifest, build hooks, src/, a .pyi stub, the revision stamp, a simpletest, tests), how a module inside micropython-pydevices differs from one in its own repository, one way to credit outside code (third_party// with LICENSE and ORIGIN.txt, plus a root NOTICE), and one pin file, DEPENDENCIES.lock, in the <name> <url> <full sha> format.

It also rewrites the tests rule to match what modules already do: tests/ holds what CI runs, tests/hardware/ holds board checks, and a check against an outside reference sits beside the module's test.

@bdbarnett
bdbarnett merged commit 5cb909f into main Oct 29, 2026
7 checks passed
@bdbarnett
bdbarnett deleted the docs/native-modules branch October 29, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant