Skip to content

Keep Authors and Instruments first in the plugin README #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seb5g merged 2 commits into from
Nov 4, 2026
Merged

Keep Authors and Instruments first in the plugin README #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62fc2f2
AGENTS.md: keep Authors and Instruments first in the README
claude Nov 4, 2026
128bec2
README: move the Development section after the Instruments list
claude Nov 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
20 changes: 10 additions & 10 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down Expand Up @@ -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).
Loading