docs(skills): add dpdata plugin skill#954
docs(skills): add dpdata plugin skill#954njzjz-bot wants to merge 4 commits intodeepmodeling:masterfrom
Conversation
dosubot
bot
added
the
size:L
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughNew documentation guide Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Merging this PR will degrade performance by 13.47%
|
| Mode | Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|---|
| ❌ | WallTime | test_import |
9.8 ms | 11.3 ms | -13.47% |
Comparing njzjz-bot:skills/dpdata-plugin-skill (3807cb1) with master (80abfc5)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #954 +/- ##
==========================================
+ Coverage 86.37% 86.63% +0.26%
==========================================
Files 86 86
Lines 8086 8006 -80
==========================================
- Hits 6984 6936 -48
+ Misses 1102 1070 -32 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds a new “dpdata-plugin” skill document describing how to build and distribute external dpdata Format plugins via pyproject.toml entry points, and updates .gitignore to ignore common local uv development artifacts.
Changes:
- Add
skills/dpdata-plugin/SKILL.mddocumenting external plugin discovery and a minimal plugin package template. - Ignore
uv.lockand.venv/in.gitignorefor local development.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| skills/dpdata-plugin/SKILL.md | New skill documentation for creating/distributing external dpdata plugins via entry points |
| .gitignore | Ignore local uv lockfile and virtualenv directory |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
CodSpeed flagged a small import-time regression. To minimize any chance of CI noise, I reverted the Authored by OpenClaw (model: gpt-5.2) |
|
Note: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
skills/dpdata-plugin/SKILL.md (1)
108-113: Add a key-collision check to the debug checklistPlease add a checklist bullet to verify the registered key (e.g.,
random) does not collide with existing built-in or external plugin keys, since later-loaded plugins can overwrite prior registrations silently.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/dpdata-plugin/SKILL.md` around lines 108 - 113, Add a checklist bullet to skills/dpdata-plugin/SKILL.md under "Debug checklist" that instructs users to verify the plugin's registered key (e.g., the string passed to `@Format.register`, such as "random") doesn't collide with built-in or previously loaded plugin keys; specifically check the registry for existing keys before registering to avoid silent overwrites by later-loaded plugins.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/dpdata-plugin/SKILL.md`:
- Around line 94-104: The verification snippet fails because the example plugin
package isn't installed into the uv environment, so Format.get_formats() won't
include the "random" entry; fix the SKILL.md example by installing the plugin
into the uv environment before running the test (e.g., run uv pip install -e .
prior to uv run) so that dpdata's entry points are registered and
Format.get_formats() returns True.
---
Nitpick comments:
In `@skills/dpdata-plugin/SKILL.md`:
- Around line 108-113: Add a checklist bullet to skills/dpdata-plugin/SKILL.md
under "Debug checklist" that instructs users to verify the plugin's registered
key (e.g., the string passed to `@Format.register`, such as "random") doesn't
collide with built-in or previously loaded plugin keys; specifically check the
registry for existing keys before registering to avoid silent overwrites by
later-loaded plugins.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d1ada6e5-1002-453c-aacd-8ad8e4814222
📒 Files selected for processing (1)
skills/dpdata-plugin/SKILL.md
wanghan-iapcm
left a comment
wanghan-iapcm
left a comment
There was a problem hiding this comment.
please check the suggestions raised by the AI reviewers.
Install the example plugin into the same environment before verifying registration so the entry point is actually discovered. Also add a debug checklist item reminding users to avoid collisions with existing format keys. Authored by OpenClaw (model: gpt-5.4)
Use the real parameter name in the example and explain that this sample interprets it as an integer frame count for generating random frames.\n\nAuthored by OpenClaw (model: gpt-5.4)
This PR adds an Agent Skill under
skills/describing how to create and install external dpdata plugins (Format.register +project.entry-points."dpdata.plugins").Authored by OpenClaw (model: gpt-5.2)
Summary by CodeRabbit