Repository navigation
Close gaps the plugin conversion opened #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # Contributing | ||
|
|
||
| Issues and pull requests are welcome. This file exists because the repo has five rules that | ||
| aren't obvious from reading the code, and each one has already caused a real bug. | ||
|
|
||
| `.github/workflows/validate.yml` enforces all of them. If CI fails on your PR, it is probably | ||
| one of these. | ||
|
|
||
| ## 1. Markers are never renamed | ||
|
|
||
| `<!-- stackwich:v1 -->` is a permanent search key, not a version number. A release that | ||
| searched for a different string could not find existing installs to upgrade — it would append | ||
| a second policy block beside the old one instead of replacing it. | ||
|
|
||
| The `v1` is frozen forever. The actual revision lives on a `policy-rev` comment **inside** the | ||
| block. | ||
|
|
||
| ## 2. Each port keeps the marker it shipped with | ||
|
|
||
| `grok/` reuses `stackwich:v1`. `codex/` uses `stackwich-codex:v1`. They differ because Codex | ||
| shipped first with its own marker, and rule 1 applies to it too. | ||
|
|
||
| Ports also carry their own counters — `stackwich-grok-rev`, `stackwich-codex-rev` — starting at | ||
| 1. A port tracks the parent's **layer structure**, not its revision number. Bumping the parent | ||
| does not oblige a port bump. | ||
|
|
||
| ## 3. The plugin never ships an `agents/` directory | ||
|
|
||
| Plugin-supplied agents install namespaced, as `stackwich:advisor`. The policy block refers to | ||
| `advisor`, `executor` and `verifier` by bare name, so shipping them in the plugin would break | ||
| every reference, remove the user's ability to decline scaffolding, and make rename-on-collision | ||
| impossible — a file in the plugin cache is overwritten on update. | ||
|
|
||
| The skill scaffolds them from `assets/` instead. CI fails if `plugins/stackwich/agents/` appears. | ||
|
|
||
| ## 4. Marker checks in CI match whole lines on purpose | ||
|
|
||
| These files **document their own syntax**. `SKILL.md` contains the sentence "search for the | ||
| opening marker `<!-- stackwich:v1 -->`" as prose, next to the real marker. | ||
|
|
||
| A substring check is satisfied by the documentation instead of the thing it documents. That is | ||
| not hypothetical: a release once shipped with its opening marker destroyed, and CI passed, | ||
| because the grep matched the prose. Every marker and revision assertion is an exact whole-line | ||
| count. Do not relax them to `grep -q`. | ||
|
|
||
| ## 5. `SKILL.md` and `assets/` move together | ||
|
|
||
| `SKILL.md` resolves the agent definitions relative to its own directory. Separating them | ||
| silently breaks scaffolding for every user, and nothing outside the assets check would notice. | ||
|
|
||
| ## Running the checks locally | ||
|
|
||
| ```bash | ||
| python3 -m pip install pyyaml | ||
| ``` | ||
|
|
||
| Then run the steps in `.github/workflows/validate.yml`. There is no separate test command — the | ||
| workflow is the test suite. | ||
|
|
||
| ## Versioning | ||
|
|
||
| One version for the repo, declared in `plugins/stackwich/.claude-plugin/plugin.json` and the | ||
| skill's frontmatter. CI asserts they agree and that `CHANGELOG.md` has a matching heading. | ||
|
|
||
| `policy-rev` is separate and only moves when the policy block's content changes. |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2026 Abhirup Banerjee (@ovhirup) | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When users install the
codex/directory, this top-levelauthorfield makes the skill fail Codex's standardquick_validate.py: its frontmatter schema allows onlyname,description,license,allowed-tools, andmetadata, and reportsauthoras unexpected. Store the author beneathmetadataas the parent skill already does; the new workflow currently masks this incompatibility by explicitly accepting either placement.Useful? React with 👍 / 👎.