Skip to content

docs: shareable science projects — fork/clone-and-continue + open-source-your-paper emphasis#46

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/shareable-science-projects
Jul 10, 2026
Merged

docs: shareable science projects — fork/clone-and-continue + open-source-your-paper emphasis#46
Jammy2211 merged 1 commit into
mainfrom
feature/shareable-science-projects

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Closes #45.

Summary

Adds the missing user-facing emphasis that a science project is built to be shared: a collaborator forks or clones the project repo and continues the work with their own autolens_assistant, and the same repo is the natural open-source companion to the paper (data or its availability statement, results, every python script).

  • Generated project README.md template (previously missing — the Publish gate referenced a README that Create never scaffolded): Reproduce this analysis / Continue this work (fork or clone + assistant refer-back via $AUTOLENS_ASSISTANT → sibling → clone-on-demand) / Data availability placeholder / Citation.
  • Collaborate phase: opens with built-to-be-shared; new bullet spelling out a collaborator's entire fork-and-continue first session (refer-back resolution, journal + provenance-drift check, manifests). README's "Continue this work" is the whole onboarding.
  • Publish phase: framed as producing the paper's open-source companion; data-availability gate item now points at the scaffolded README section.
  • Top-level README.md: "Built to be shared" pitch in the Science Project section + a new share-with-collaborator example prompt + sharpened publish prompt (DOI included).
  • Skill frontmatter description: gains "continue a collaborator's project" and "open-source the repo that goes with my paper" triggers.

Scripts Changed

None — documentation only (README.md, skills/start-new-project.md). No scripts, notebooks, or configs touched.

Validation

  • autoassistant/audit_skill_apis.py --check-citations: 90 files, 388 citations, 0 missing paths, 0 warnings.
  • Consistency read: Create tree ↔ README template ↔ Publish gate reference the same files.
  • No personal content (repo is a generic public template).

Readiness

Heart YELLOW on the standing 6-reason set (repeatedly human-acked in-session 2026-07-10); no new reasons; docs-only change to a repo not on the library release train (no pending-release label exists here — deliberate).

Absorbs the retired PyAutoMind prompt science_project_collaborator_clone.md.

🤖 Generated with Claude Code

…, paper-companion emphasis (#45)

The generated project gains its missing README.md front door (reproduce /
continue-this-work / data-availability placeholder / citation); Collaborate
now opens with built-to-be-shared and spells out a collaborator's fork-and-
continue first session via refer-back; Publish frames the public repo as the
paper's open-source companion; the top-level README pitches both, with new
share/publish example prompts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Jammy2211
Jammy2211 merged commit 2ceedf4 into main Jul 10, 2026
1 check failed
@Jammy2211
Jammy2211 deleted the feature/shareable-science-projects branch July 10, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: shareable science projects — fork/clone-and-continue + open-source-your-paper emphasis

1 participant