docs: document npm as a distribution channel#68
Merged
Conversation
Two follow-up edits to address review feedback on #67 (feat: ship as npm package via @netresearch/agent-skill-coordinator): - docs/ARCHITECTURE.md: add npm to the Distribution Channels section so future maintainers see it as a packaging surface that must be considered when changing release or distribution logic. - skills/github-project/references/multi-repo-operations.md: clarify that `package.json.version` parity rules differ by package type — skill packages use `0.0.0-source` (publish-time-rewritten); the coordinator-style packages keep parity with `plugin.json`. Resolves copilot-pull-request-reviewer threads PRRT_kwDOQoDmGs5_GzUj and PRRT_kwDOQoDmGs5_GzUo. Signed-off-by: Sebastian Mendel <sebastian.mendel@netresearch.de>
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the project's documentation to include the npm distribution channel and clarifies versioning requirements for multi-repo operations, specifically regarding package.json placeholders. Feedback was provided to ensure consistency with the rule that composer.json should not contain a version field, to specify exact license filenames in the documentation, and to clarify confusing terminology where a package name was used as a version example.
There was a problem hiding this comment.
Pull request overview
Updates project documentation to explicitly include npm as a supported distribution channel and to refine version-parity guidance for repos that ship via npm (accounting for the 0.0.0-source placeholder pattern).
Changes:
- Document npm as an additional distribution channel alongside Composer, Claude plugin, npx/skills.sh, and manual installs.
- Clarify the multi-repo pre-flight version validation rules for npm-shipping repos, including the
0.0.0-sourceplaceholder case.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/ARCHITECTURE.md | Adds npm to the Distribution Channels section and notes the npm files allowlist constraint. |
| skills/github-project/references/multi-repo-operations.md | Updates version-parity guidance to reflect npm placeholder vs released-version patterns. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…PR review) multi-repo-operations.md line 106 contradicted line 120: the pre-flight asked for plugin.json/composer.json version parity, but composer.json in Netresearch skill repos must NOT have a version field (Packagist derives versions from git tags). Replace with the correct negative assertion plus a SKILL.md frontmatter parity check. Also tighten line 107 to clarify that matching package.json.version applies to coordinator-style packages, not the example dependency. ARCHITECTURE.md line 34 used 'LICENSE files' as a placeholder inside an inline files array, which would be an invalid literal entry. Replace with the actual allowlist values (LICENSE-MIT, LICENSE-CC-BY-SA-4.0) so the snippet is copy-pasteable. Signed-off-by: Sebastian Mendel <sebastian.mendel@netresearch.de>
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.
Summary
Two follow-up doc edits addressing review threads on #67 that were not fixed in the merged code:
docs/ARCHITECTURE.md: add npm to the Distribution Channels section. Previously listed only Composer, Claude Code plugin, npx/skills.sh, and manual installs — future maintainers wouldn't see npm as a packaging surface to consider.skills/github-project/references/multi-repo-operations.md: clarify the version-parity rule. The pre-merge guidance saidplugin.json.version/composer.json.version/package.json.versionmust all match — but skill packages intentionally ship0.0.0-sourceinpackage.json(publish-time rewritten), so blanket parity would flag the merged shape as broken.Addresses
package.json:3(PRRT_kwDOQoDmGs5_GzUj)README.md:137(PRRT_kwDOQoDmGs5_GzUo)Test plan