Skip to content

docs: 增加 AGENTS.md - #1

Merged
residua1 merged 5 commits into
mainfrom
docs/agent-friendly
Oct 22, 2026
Merged

residua1 merged 5 commits into
mainfrom
docs/agent-friendly

Conversation

@residua1

Copy link
Copy Markdown
Contributor

改动

  • 增加 AGENTS.md:加载器目录、宿主断言与打包命令、缓存和隔离不变量。

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-22T10:01:47.458531Z c0232eb Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7a5bf0709f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md Outdated
Comment on lines +27 to +28
- The package is a plugin package named `hosihikari-fsharp`; its manifest routes on
`extraInfo.loader: fsharp` and entry `main.fsx`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Describe the loader package's actual manifest

This conflates the loader package with an F# source package. pack.ps1 creates hosihikari-fsharp with entry Hosihikari.PluginLoader.FSharp.dll and extraInfo.loader = assembly; main.fsx and loader = fsharp belong to packages that consume this loader. An agent following this stated invariant while changing packaging could prevent LoaderBootstrap from loading and registering the F# loader.

Useful? React with 👍 / 👎.

Comment thread AGENTS.md Outdated
Comment on lines +29 to +30
- Compile-time references follow the runtime order: framework shared layer, package-local DLLs,
then trusted platform assemblies.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Include the loader dependency tier in the reference order

This reference-order invariant omits the loader directory between package-local assemblies and the trusted platform assemblies. CollectReferences deliberately includes that tier for dependencies shipped with the loader, such as FSharp.Core; preserving only the three documented tiers during future changes can make otherwise valid scripts fail compilation or resolve differently at runtime.

Useful? React with 👍 / 👎.

@residua1

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5173cb6070

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md Outdated
- `src/` — loader implementation and cache.
- `host/` — assertion host for compilation, caching, isolation, and unload.
- `test/` — fixture packages and private dependencies.
- `pack.ps1`, `pack.sh` — build the `hosihikari-fsharp` lip package.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove the nonexistent pack.sh entry

The repository map advertises pack.sh as a supported packaging script, but a repo-wide file listing at this commit contains only pack.ps1, and the documented workflow invokes that PowerShell script. An agent following this guidance on Linux will try to run or maintain a file that does not exist; either add the shell wrapper or list only pack.ps1.

Useful? React with 👍 / 👎.

@residua1

Copy link
Copy Markdown
Contributor Author

@codex review

1 similar comment
@residua1

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 71755a9a42

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md Outdated
```

The host expects sibling `PluginManager`, `Plugin.Abstractions`, and
`Hosihikari.McMaster.NETCore.Plugins` checkouts. `pack.ps1` calls the core packer and needs the same

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Name the McMaster checkout directory the build expects

When a contributor follows this prerequisite literally, cloning into a sibling named Hosihikari.McMaster.NETCore.Plugins will not reproduce the verification layout. The checked workflow explicitly places that repository at McMaster.NETCore.Plugins because the core project resolves the fork by that path (.github/workflows/verify.yml, lines 35–40), so the documented name can cause the host to miss the required fork.

Useful? React with 👍 / 👎.

Comment thread AGENTS.md Outdated
the loader directory (for dependencies such as `FSharp.Core`), then trusted platform assemblies.
- Cache keys cover source text, `#load` and local `#r` inputs, package-local DLLs, compiler version,
and runtime version. Keep the checksum check in sync.
- A failed load releases its ALC; one package exposes exactly one `IPlugin` type.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Describe the actual plugin entry-point predicate

The loader does not require exactly one type assignable to IPlugin; FSharpPluginLoader.Load first excludes abstract/interface types and implementations without a public parameterless constructor, then requires exactly one remaining candidate. A script containing an abstract IPlugin base or another non-constructible implementation alongside one valid entry point is accepted today, so this stricter invariant can lead future changes to reject packages the loader intentionally supports.

Useful? React with 👍 / 👎.

@residua1

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c8eea78d47

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md Outdated
Comment on lines +27 to +28
entry `Hosihikari.PluginLoader.FSharp.dll`. Source packages it handles use
`extraInfo.loader: fsharp` and entry `main.fsx`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document arbitrary source entry paths

For source packages whose manifest points to a custom or nested script, this states an invariant that the entry must be main.fsx, even though FSharpPluginLoader.Load uses manifest.EntryPath and the assertion host explicitly exercises entry: "src/main.fsx" in host/Program.cs. Future changes following this guidance could reject or rewrite currently supported package layouts; describe main.fsx as a conventional example rather than a requirement.

Useful? React with 👍 / 👎.

@residua1

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Bravo.

Reviewed commit: c0232eb23b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@residua1
residua1 merged commit df65029 into main Oct 22, 2026
2 checks passed
@residua1
residua1 deleted the docs/agent-friendly branch October 22, 2026 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants