Add agent skill - #122
Merged
Merged
Conversation
Bundle a SKILL.md agent reference inside the package and a neworder-skill console script to install it into a project, plus a documentation-site page describing it. The skill summarises the model lifecycle, timelines, the MonteCarlo and SplitMix64 engines, neworder.df, spatial domains and MPI patterns, and links back to neworder.readthedocs.io for detail rather than restating it. Install is by symlink to the copy inside the installed package where the platform permits, falling back to a copy on Windows without developer mode; both --install and --remove refuse to touch anything they don't own. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #122 +/- ##
=======================================
Coverage 95.57% 95.57%
=======================================
Files 15 15
Lines 723 723
=======================================
Hits 691 691
Misses 32 32 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
os.path.relpath raises ValueError when the installed package and the target project are on different drives, which is the normal case on the CI runners (package on D:, temp dir on C:). Fall back to an absolute symlink target when there is no relative path. Co-Authored-By: Claude Opus 5 <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.
Ports virgesmith/xenoform-rs#24 to this repo: an agent skill bundled inside the package, plus a console script to install it into a project. Documented on the docs site rather than in the README.
What
neworder/skill/SKILL.md— a compact reference for AI coding agents covering themodify→step/check→finaliselifecycle, the four timeline types (andhalt()), theMonteCarloandSplitMix64engines with their seeding strategies,neworder.df.transition/transition_conditional/unique_index, spatial domains, MPI patterns, and the framework's recurring pitfalls (uninitialised base class, strict C++ typing,NEVERbeing NaN, per-agent python loops).neworder/skill_cli.py— aneworder-skillconsole script with--install [PATH]/--remove [PATH](defaultPATH=.agents, so.agents/skills/neworder), registered under[project.scripts].package_datainsetup.pyships the skill in the wheel and sdist.docs/agent-skill.md+ nav entry inzensical.toml, and a two-line pointer to it fromREADME.md.test/test_skill_cli.py— 13 tests covering install/remove, default path, idempotency, the copy fallback and stale-copy refresh, and the refusals.Notes
neworder.readthedocs.io/en/stable/; the body is a summary an agent can hold in context, not a second copy of the docs. That is also why the user-facing docs for this feature are a docs-site page — the README is inlined intodocs/index.mdviainclude_snippet, so anything longer there would duplicate the new page on the site's front page.symlink_toneeds developer mode — so--installfalls back toshutil.copytree, and re-running it refreshes a copy (which, unlike a symlink, goes stale on upgrade).neworder/skill/SKILL.mdis packaged and the entry point registered —[tool.cibuildwheel]runs the test suite against the installed wheel, so the new tests would fail there otherwise.Gates:
ruff check,ruff format --check,ty check neworder examples test,pytest(102 passed, 1 skipped) all green;zensical buildclean;examples/hello_world/model.pyruns.JOURNAL.mdentry added.🤖 Generated with Claude Code