Repository navigation
Keep Authors and Instruments first in the plugin README - #67
Merged
Merged
Conversation
pymodaq_plugin_manager reads the README in that order. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg
Authors and Instruments must come first: the plugin manager reads the README in that order. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg
This was referenced Nov 4, 2026
Merged
Open
Merged
Open
Merged
Open
Open
Open
Open
This was referenced Nov 4, 2026
Open
Open
Open
Open
Merged
Open
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before:
AGENTS.mdsays nothing about the order of the sections of a plugin README, and the README of the template itself has a "Development" section before "Authors". A plugin README written from it, or by an assistant adding requirements or notes at the top, breaks the waypymodaq_plugin_managerreads it.After: the "Done checklist" of
AGENTS.mdstates the order (a short description,Authors,Contributorsif needed,Instruments) and that nothing else goes before these sections or between them: requirements, installation, hardware notes or differences with another branch come after theInstrumentslist. The "Development" section of the template README moves after the "Installation instructions" at the end.How: the rule comes from
extract_authors_from_descriptioninpymodaq_plugin_manager/validate.py(1.3.8): it starts atAuthorsand stops atContributorsorInstruments. Documentation change only; the README still builds as before (no code touched). Found while updating the README ofpymodaq_plugins_daqmx(#19, #20).Generated by Claude Code