Repository navigation
AGENTS.md: keep Authors and Instruments first in the README - #18
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
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: the "Done checklist" of
AGENTS.mdsays only that theREADME.rstmust be updated. An assistant (or a contributor) may then write requirements or notes before theAuthorsandInstrumentssections, which breaks the waypymodaq_plugin_managerreads the README.After: the checklist states the order (a short description,
Authors,Contributorsif needed,Instruments) and that other sections come after theInstrumentslist.How: same sentence as the plugin template (PyMoDAQ/pymodaq_plugins_template#67). The rule comes from
extract_authors_from_descriptioninpymodaq_plugin_manager/validate.py(1.3.8): it starts atAuthorsand stops atContributorsorInstruments. Documentation change only, no code touched.Generated by Claude Code