docs: add model contribution skill and placement guidance - #65
Merged
Merged
Conversation
Signed-off-by: Hongsheng Liu <liuhongsheng4@huawei.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.
Purpose
Contributors need an explicit workflow for adding models, including code placement, tests outside
src/, and the documentation that must accompany an implementation.Add the optional
add-new-modelskill and link it fromCONTRIBUTING.md. The skill covers pinned inference contracts, model-owned execution and shared backend integration, repository-level tests and Rust test registration, validation, and a file-by-file documentation checklist. PRs #19 and #55 serve as worked examples, with current placement rules taking precedence over historical layouts.The contributor guide makes the test-placement rule explicit: test bodies, helpers, and fixtures belong under root
tests/; only external test-module registration wiring may remain insrc/.Test Plan
System1-Omni Version / Commit: base
1be7d41eb74d5b49fd25194042041319950e5dce; head8066aa5bf7770f728382e7e801d02aeac62b3ad6.Validate the skill, build the documentation with the pinned requirements, check relative links and the rendered skill link, and review the complete two-file diff.
Test Result
Passed locally:
quick_validate.py .agents/skills/add-new-model: valid skill frontmatter and content.mkdocs build --strict: passed using an existing environment matchingdocs/requirements.txt.git diff --cached --check: passed.The full diff was reviewed for scope, architecture, placement guidance, documentation accuracy, and reference links. Rust and GPU checks were not run because this change only adds documentation and skill instructions. No accuracy or performance claims are made.
Self-review
Before marking this PR ready for review or requesting maintainer review, complete
the contributor self-review checklist.
The PR is a draft; the contributor checklist remains for the author to complete.