From 62fc2f210ec59d1dfe43ee3d4a5fa05c33aa2b23 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 4 Nov 2026 16:47:16 +0000 Subject: [PATCH 1/2] AGENTS.md: keep Authors and Instruments first in the README pymodaq_plugin_manager reads the README in that order. Co-Authored-By: Claude Sonnet 5.5 Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg --- AGENTS.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 9905a4f..c28adf8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -263,4 +263,8 @@ extensions already does the job and only the conversion of the measurements or o - [ ] Tests added for new behaviour using a mock controller (no real hardware in CI). - [ ] Docstring of each plugin class states: compatible devices, what was tested, PyMoDAQ and OS versions, drivers to install. -- [ ] `README.rst` updated; target PyMoDAQ version stated. +- [ ] `README.rst` updated; target PyMoDAQ version stated. Keep its section order: a short description, then `Authors` + (then `Contributors` if needed), then `Instruments` (`Actuators`, `Viewer0D`...). `pymodaq_plugin_manager` reads the + README from `Authors` to `Instruments` (`extract_authors_from_description` in its `validate.py`), so write nothing + else before these sections or between them: requirements, installation, hardware notes or differences with + another branch come after the `Instruments` list. From 128bec2c3af455ef99c00703f20be94978598d56 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 4 Nov 2026 16:47:30 +0000 Subject: [PATCH 2/2] README: move the Development section after the Instruments list Authors and Instruments must come first: the plugin manager reads the README in that order. Co-Authored-By: Claude Sonnet 5.5 Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg --- README.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index b369419..0ac3522 100644 --- a/README.rst +++ b/README.rst @@ -23,16 +23,6 @@ Use this template to create a repository on your account and start the developme This branch targets **PyMoDAQ 5.3.x** (Python 3.10 to 3.13). Use the branch matching your PyMoDAQ version. -Development -=========== - -* Install your plugin in editable mode: ``pip install -e .`` -* Check it, without any hardware: ``check_plugin`` (and ``pytest``) -* If you use an AI coding assistant, point it to ``AGENTS.md``: it describes the patterns to follow for instrument - plugins, Dashboard extensions (``CustomExt``, whenever instruments are involved) and standalone apps - (``CustomApp``, only if no instruments are needed). - - Authors ======= @@ -97,3 +87,13 @@ Installation instructions * PyMoDAQ’s version. * Operating system’s version. * What manufacturer’s drivers should be installed to make this plugin run? + + +Development +=========== + +* Install your plugin in editable mode: ``pip install -e .`` +* Check it, without any hardware: ``check_plugin`` (and ``pytest``) +* If you use an AI coding assistant, point it to ``AGENTS.md``: it describes the patterns to follow for instrument + plugins, Dashboard extensions (``CustomExt``, whenever instruments are involved) and standalone apps + (``CustomApp``, only if no instruments are needed).