Repository navigation
Add maintenance plan, AI-assistance disclosure and paper context to the README - #4
Merged
Merged
Conversation
…he README README: rewrite the opening and add "What to expect" from the manuscript (training data, where the model generalised, where it fails, when to fine-tune); add a Maintenance section with the active-public-code statement, roles, response time, release and wind-down plan; add "How this code was developed" disclosing AI assistance and the cyto-dl origin. CONTRIBUTING gains an AI-assisted contributions section and the PR template a matching checklist item, per the Institute's coding-agent guidelines. Existing RELEASE TODO comments are kept. Assisted-by: claude-code (claude-fable-5-1) Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…tions Assisted-by: claude-code (claude-fable-5-1) Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Assisted-by: claude-code (claude-fable-5-1) Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Assisted-by: claude-code (claude-fable-5-1) Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.
What changed
Assisted-by:trailer policy. One new RELEASE TODO: verify masks against the cyto-dl predictions.Why
Items 1 (maintenance plan), 4 (AI usage disclaimer) and part of 5 (docs edit pass) from the public-release review. The new prose is written from the paper rather than generic, which is also the fix for the "reads AI generated" comment; please edit it into your own words where it does not sound like you.
How it was tested
Docs only. Markdown previewed locally; no code changes.
Checklist
pytest) (unchanged code)CHANGELOG.mdhas an entry under Unreleased (not user-visible behaviour)🤖 Generated with Claude Code