-
Notifications
You must be signed in to change notification settings - Fork 0
docs: update CLAUDE.md with behavioral guidelines and project-specifi… #21
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # .claude | ||
|
|
||
| ## Role | ||
| - Owns Claude-specific repo automation, commands, and local assistant state. | ||
|
|
||
| ## Owns | ||
| - Slash-command definitions in `commands/`. | ||
| - Claude-local workflow assets that do not ship in the npm package. | ||
|
|
||
| ## Avoid | ||
| - Do not place runtime plugin code here. | ||
| - Do not make product behavior depend on local worktree or cache content. |
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,12 @@ | ||
| # .claude/commands | ||
|
|
||
| ## Role | ||
| - Owns slash-command entry files for spec-kit and related Claude workflows. | ||
|
|
||
| ## Owns | ||
| - One markdown command file per command. | ||
| - Command wording, arguments, and invocation flow only. | ||
|
|
||
| ## Avoid | ||
| - Do not duplicate product documentation here. | ||
| - Do not encode runtime plugin logic in command files. |
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,12 @@ | ||
| # .github | ||
|
|
||
| ## Role | ||
| - Owns repository automation and CI/CD configuration. | ||
|
|
||
| ## Owns | ||
| - Workflow definitions in `workflows/`. | ||
| - Review, publish, and repo-policy automation. | ||
|
|
||
| ## Avoid | ||
| - Do not move product logic from `src/` into GitHub automation. | ||
| - Do not broaden permissions or secret usage without a release or security need. |
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,11 @@ | ||
| # .github/workflows | ||
|
|
||
| ## Role | ||
| - Owns executable GitHub Actions workflows for review and publish paths. | ||
|
|
||
| ## Owns | ||
| - Trigger rules, job graphs, permissions, and release automation. | ||
|
|
||
| ## Avoid | ||
| - Keep workflow permissions least-privilege. | ||
| - Keep steps reproducible from tracked repo files; avoid hidden local assumptions. |
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 |
|---|---|---|
|
|
@@ -78,3 +78,5 @@ skills-lock.json | |
|
|
||
| # specs (development-only, not shipped) | ||
| specs/ | ||
|
|
||
| doc | ||
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,13 @@ | ||
| # .specify | ||
|
|
||
| ## Role | ||
| - Owns spec-kit scaffolding, templates, memory, and helper scripts for planning workflows. | ||
|
|
||
| ## Owns | ||
| - Generated planning context in `memory/`. | ||
| - Bootstrap scripts in `scripts/`. | ||
| - Reusable artifact templates in `templates/`. | ||
|
|
||
| ## Avoid | ||
| - Do not couple runtime plugin behavior to files here. | ||
| - Root `CLAUDE.md` is managed by `scripts/powershell/update-agent-context.ps1`; treat it as generated context. |
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 |
|---|---|---|
| @@ -1,10 +1,12 @@ | ||
| <claude-mem-context> | ||
| # Recent Activity | ||
| # .specify/memory | ||
|
|
||
| ### Mar 13, 2026 | ||
| ## Role | ||
| - Owns generated spec-kit memory and long-lived planning context. | ||
|
|
||
| | ID | Time | T | Title | Read | | ||
| |----|------|---|-------|------| | ||
| | #1610 | 10:13 PM | 🟣 | OpenCode property forwarding feature completed and submitted for review | ~1768 | | ||
| | #1605 | 10:03 PM | 🟣 | Feature planning completed for OpenCode property forwarding to observability backends | ~1466 | | ||
| </claude-mem-context> | ||
| ## Owns | ||
| - `constitution.md` and other machine-maintained memory inputs. | ||
| - Context snapshots consumed by spec-kit update scripts. | ||
|
|
||
| ## Avoid | ||
| - Treat files here as tooling state, not product docs. | ||
| - Do not store runtime source rules here when they belong in repo-level instructions. |
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,12 @@ | ||
| # .specify/scripts | ||
|
|
||
| ## Role | ||
| - Owns automation entrypoints that bootstrap and update spec-kit artifacts. | ||
|
|
||
| ## Owns | ||
| - Shell-specific implementations in child folders. | ||
| - Cross-script orchestration boundaries and invocation contracts. | ||
|
|
||
| ## Avoid | ||
| - Do not add product runtime logic here. | ||
| - Keep script behavior aligned with templates and generated-context expectations. |
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 |
|---|---|---|
| @@ -1,10 +1,12 @@ | ||
| <claude-mem-context> | ||
| # Recent Activity | ||
| # .specify/scripts/powershell | ||
|
|
||
| ### Mar 13, 2026 | ||
| ## Role | ||
| - Owns PowerShell implementations of spec-kit setup and agent-context update flows. | ||
|
|
||
| | ID | Time | T | Title | Read | | ||
| |----|------|---|-------|------| | ||
| | #1610 | 10:13 PM | 🟣 | OpenCode property forwarding feature completed and submitted for review | ~1768 | | ||
| | #1605 | 10:03 PM | 🟣 | Feature planning completed for OpenCode property forwarding to observability backends | ~1466 | | ||
| </claude-mem-context> | ||
| ## Owns | ||
| - Feature bootstrap scripts. | ||
| - Shared PowerShell helpers and repo-context update scripts. | ||
|
|
||
| ## Avoid | ||
| - Preserve compatibility with generated root agent-context files. | ||
| - Do not add repo product behavior here beyond scaffolding support. |
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 |
|---|---|---|
| @@ -1,10 +1,11 @@ | ||
| <claude-mem-context> | ||
| # Recent Activity | ||
| # .specify/templates | ||
|
|
||
| ### Mar 13, 2026 | ||
| ## Role | ||
| - Owns reusable markdown templates that seed future spec, plan, task, and agent-context artifacts. | ||
|
|
||
| | ID | Time | T | Title | Read | | ||
| |----|------|---|-------|------| | ||
| | #1610 | 10:13 PM | 🟣 | OpenCode property forwarding feature completed and submitted for review | ~1768 | | ||
| | #1605 | 10:03 PM | 🟣 | Feature planning completed for OpenCode property forwarding to observability backends | ~1466 | | ||
| </claude-mem-context> | ||
| ## Owns | ||
| - Template structure, placeholders, and generated-file boilerplate. | ||
|
|
||
| ## Avoid | ||
| - Template changes affect future generated files, not current source directly. | ||
| - Keep templates generic; do not hard-code one-off feature decisions here. |
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 @@ | ||
| D:/openSource/opencode/docs/plugin-sdk-api.md |
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 |
|---|---|---|
| @@ -1,10 +1,15 @@ | ||
| <claude-mem-context> | ||
| # Recent Activity | ||
| # src | ||
|
|
||
| ### Mar 13, 2026 | ||
| ## Role | ||
| - Owns the shipped plugin runtime and OTEL integration logic. | ||
|
|
||
| | ID | Time | T | Title | Read | | ||
| |----|------|---|-------|------| | ||
| | #1614 | 10:31 PM | 🟣 | PR #12 merged: OpenCode property forwarding to observability backends | ~1032 | | ||
| | #1610 | 10:13 PM | 🟣 | OpenCode property forwarding feature completed and submitted for review | ~1768 | | ||
| </claude-mem-context> | ||
| ## Owns | ||
| - Plugin entry, config parsing, exporter/provider wiring, stderr interception, session state, and shutdown flow. | ||
|
|
||
| ## Boundaries | ||
| - Keep `index.ts` orchestration-only. | ||
| - Keep config parsing in `config.ts`, transport wiring in `provider.ts`, and stderr interception in `interceptor.ts`. | ||
|
|
||
| ## Avoid | ||
| - Do not place tests, workflow automation, or planning artifacts here. | ||
| - Do not let one module absorb another module's responsibility just to avoid a new file. |
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,12 @@ | ||
| # tests | ||
|
|
||
| ## Role | ||
| - Owns automated verification for the plugin. | ||
|
|
||
| ## Owns | ||
| - Test organization, fixtures, and shared testing conventions. | ||
| - Fast unit coverage in `unit/`. | ||
|
|
||
| ## Avoid | ||
| - Do not duplicate production logic in tests. | ||
| - Keep flaky timing, network access, and external collector dependencies out of this tree. |
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 |
|---|---|---|
| @@ -1,11 +1,11 @@ | ||
| <claude-mem-context> | ||
| # Recent Activity | ||
| # tests/unit | ||
|
|
||
| ### Mar 13, 2026 | ||
| ## Role | ||
| - Owns fast, deterministic unit tests for modules under `src/`. | ||
|
|
||
| | ID | Time | T | Title | Read | | ||
| |----|------|---|-------|------| | ||
| | #1614 | 10:31 PM | 🟣 | PR #12 merged: OpenCode property forwarding to observability backends | ~1032 | | ||
| | #1612 | 10:21 PM | 🔴 | Fixed provider.shutdown() to await properly in resource attribute tests | ~432 | | ||
| | #1610 | 10:13 PM | 🟣 | OpenCode property forwarding feature completed and submitted for review | ~1768 | | ||
| </claude-mem-context> | ||
| ## Owns | ||
| - Module-level behavior checks for config parsing, interception, provider setup, and session-safe changes. | ||
|
|
||
| ## Avoid | ||
| - Do not turn these tests into integration or e2e suites. | ||
| - Prefer direct behavior assertions over duplicating implementation details. |
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.
Adding
docto.gitignorewhile simultaneously committing a tracked file indoc/plugin-sdk-api.mdis contradictory. Furthermore, this change is unrelated to the PR's focus onCLAUDE.mdfiles and should be removed to maintain surgical changes.