Repository navigation
State the intent to publish, and get ready for outside contributors - #163
Merged
Merged
Conversation
Write down where and why we mean to publish jupyddl as citable research software (.docs/PUBLISHING.md): a Zenodo DOI per release, a JOSS paper, ICAPS workshops for the research results, with a readiness checklist, the paper outline, the AI-usage disclosure JOSS requires, and how contributors can be considered for authorship. The README states the project's aim and its Cite section now says which version the 2021 preprint describes. Add the community files an outside contributor expects: a security policy, a pull-request template, a "Propose an algorithm" issue template, and an "Adding an algorithm" section in CONTRIBUTING.md. Run tests and build on pull requests. They were `on: [push]`, which never fires for a fork, so a contributor's PR showed no checks at all. Fix AGENTS.md drift: the Python floor is 3.10 and Mergify is retired. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014RbGtRHF8XhkiPQCDVHtV2
guilyx
marked this pull request as ready for review
November 2, 2026 21:31
guilyx
pushed a commit
that referenced
this pull request
Nov 2, 2026
# Conflicts: # .docs/PUBLISHING.md # AGENTS.md # CHANGELOG.md
4 tasks done
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 and why
The aim is for jupyddl to be a framework people build on: implement a planning algorithm in readable Python, compare it with the ones already here, and explain it to others. Two things follow from that, and this PR covers both.
1. A written intent to publish. The new
.docs/PUBLISHING.mdcovers:The README now states the aim. Its Cite section now says that the 2021 preprint describes the old Julia-backed version.
2. Files an outside contributor expects to find:
.github/SECURITY.mdCONTRIBUTING.mdCI now runs on pull requests.
testsandbuildwereon: [push], which never fires for a PR from a fork, so an outside contributor's PR got no checks at all. They now run onpull_requestand on pushes tomain. A branch pushed without a PR gets no CI.Stale notes fixed in AGENTS.md: the Python floor is 3.10, not 3.9, and Mergify was retired.
How it was checked
flake8is clean. The baseline suite passed (420 passed, 1 skipped). After the edits I re-rantest_web_bundle.pyandtest_learn.py, the tests that read the docs: 67 passed.CITATION.cffand both workflow files parse as YAML. The workflows listpull_request,pushandworkflow_dispatchas triggers.jupyddl/, soweb/distdoes not need rebuilding.Maintainer actions (outside this PR)
.docs/PUBLISHING.md)SECURITY.mdpoints people there.Generated by Claude Code