Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

spike(framework): define the portability boundary for agent artifacts

未关闭
#929 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
typescript

调研方向

Start by reading #619, #916, #913, and #914 alongside the current CLI capabilities, profiles, translators, flat and marketplace builds, and context generators. Exercise the named clean and existing-repository fixtures for Claude Code + Codex, then generalize across selected hosts and record evidence in a compatibility matrix. Done means the matrix, preserve-first and portable-first policy, unresolved uncertainties, and smallest justified follow-up are documented without altering user-owned artifacts.

由索引模型根据 Issue 内容生成。

描述

Problem

When multiple selected hosts natively support the same artifact surface with compatible discovery, format, and semantics, AIDD does not yet have a general policy for reusing one shared artifact and emitting a host-specific projection only when a selected host requires a different contract.

This matters especially when the same repository is used by one person or team with several AI coding hosts. A repository may be opened alternately with Claude Code, Codex, Kilo, Kimi, Cursor, OpenCode, Copilot, or other supported tools. Without a portability boundary, AIDD can generate several representations of the same logical artifact even when a common host-supported surface would be sufficient.

That portability question is downstream of ownership. This spike concerns repository-scoped artifacts and must not assume that framework-provided AIDD artifacts belong in every repository. Where a selected host supports an appropriate user/global installation for framework-owned artifacts, that ownership boundary should remain preferred. The portability problem still applies to repository-owned or project-specific artifacts that must travel with the repository, be shared by a team, be available in CI or other environments, or coexist with pre-existing host-native files. The investigation must therefore establish ownership scope before choosing a representation strategy, while recognizing that user/global support and contracts may differ between hosts.

AIDD currently has a canonical plugin source and host-specific translation profiles. Several hosts now converge on shared surfaces such as:

  • AGENTS.md
  • Agent Skills / SKILL.md
  • .agents/skills/
  • .agents/agents/

The community also contains emerging proposals and implementations for .agents/rules/. However, unlike Agent Skills, .agents/rules/ does not currently have a broadly adopted cross-host format or discovery contract. It must therefore be investigated as a candidate shared surface, not treated as an established standard.

The current implementation mostly resolves output paths from the selected host profile. It does not yet provide a general policy for discovering existing logical artifacts, reusing compatible project surfaces, or refusing unnecessary duplicates.

The investigation must not assume that .agents/ is a universal standard.

Scope

  • Establish ownership scope before portability analysis: distinguish framework-owned artifacts that may correctly remain user/global from repository-owned or project-specific artifacts that must be versioned and shared with the repository.
  • Identify when a supported user/global scope is the correct ownership boundary, and ensure the spike does not create repository-level duplication for framework artifacts already provided there.
  • Apply the portability analysis primarily to artifacts that legitimately belong to the repository, while accounting for independent user-authored artifacts and pre-existing host-native files.
  • Keep a shared repository representation only when the selected hosts can consume it compatibly, and retain host-specific projections only where discovery, format, or semantics require them.
  • Define a portability policy for project instructions, skills, agents/subagents, rules, commands/workflows, and hooks.
  • Evaluate repositories used with multiple selected AI coding hosts, not only one host at a time.
  • Distinguish a framework-owned global artifact, a repository-owned shared artifact consumed by several hosts, a required host-native projection, independent user-authored artifacts, and an accidental AIDD duplicate.
  • Define the existing-project invariant across ownership scopes: regenerating AIDD must not introduce a second representation of an existing logical artifact unless another selected host requires a semantically distinct projection. When a framework-owned artifact is correctly available at supported user/global scope, the valid repository result may be no generated copy.
  • Preserve user-owned content outside explicit AIDD-managed blocks.
  • Refuse to silently merge, delete, migrate, or choose between conflicting existing artifacts.
  • Build a host compatibility matrix covering ownership scope, discovery, precedence, format, semantic parity, reuse eligibility, required projections, and evidence.
  • Evaluate .agents/rules/ as an emerging community convention and candidate shared surface, without assuming that community adoption equals host support.
  • Determine whether any selected host combination can safely use .agents/rules/ directly, through explicit configuration, or not at all.
  • Inspect current AIDD CLI capabilities, profiles, translators, flat builds, marketplace builds, and context generators.
  • Inspect project-memory behavior when CLAUDE.md, AGENTS.md, and Copilot instruction files coexist.
  • Inspect existing skills and agents under host-specific and shared paths.
  • Exercise clean/new and existing-repository fixtures with several selected hosts.
  • Recommend the smallest follow-up: documentation, extension of an existing issue, resolver design, or separate implementation issue.

Decision boundary

Because this investigation crosses multiple host-specific issues and may define a framework-wide compatibility policy, its scope and outcome should be confirmed by a Maintainer before implementation begins.

This issue does not prescribe ownership or require a particular implementation path. A Maintainer may accept the spike, redirect it to existing issues, split the scope, or close it if the current work already provides sufficient coverage.

Required multi-host scenario

The spike must evaluate a repository used with multiple AI coding hosts selected at the same time.

The minimum scenario is Claude Code + Codex. The analysis must then generalize the result to any supported combination, including combinations such as:

  • Claude Code + Codex + Kilo + Kimi;
  • Cursor + OpenCode + Copilot;
  • any future hosts that consume the same candidate shared surface.

The scenario must cover:

  • a new repository with several hosts selected;
  • an existing repository with CLAUDE.md only;
  • an existing repository with AGENTS.md only;
  • an existing repository with both files;
  • an existing skill under .claude/skills/;
  • an existing skill under .agents/skills/;
  • an existing host-native agent and a candidate portable agent;
  • a candidate shared rule tree under .agents/rules/.

For each selected host combination, determine whether a common host-supported surface can serve all selected hosts without generating duplicate logical artifacts.

A common or standard surface must be preferred only when discovery, format, and semantics are compatible for every selected host. The existence of a shared convention alone is not sufficient evidence.

For .agents/rules/, the spike must explicitly distinguish:

  1. native discovery by every selected host;
  2. explicit, documented configuration wiring for each selected host;
  3. community or tool-specific support without cross-host parity;
  4. no proven support.

The result must identify, for every artifact:

  1. one shared artifact serving several selected hosts;
  2. a required host-specific projection;
  3. two independent user-owned artifacts;
  4. an unnecessary duplicate created by AIDD.

The existence of multiple selected hosts must never justify overwriting, merging, deleting, or migrating user-owned artifacts.

Acceptance criteria

  • The result distinguishes framework-owned artifacts that belong at user/global scope from repository-owned artifacts, identifies when a supported global installation is the correct ownership boundary, and does not introduce repository-level duplication for those framework artifacts.
  • Repository portability decisions are evaluated only after ownership scope has been established; for a framework-owned artifact correctly available at supported user/global scope, no repository output is an acceptable result.
  • A host compatibility matrix records ownership scope, discovery, format, semantic parity, reuse eligibility, required projections, and evidence links for all relevant selected-host combinations.
  • The matrix includes .agents/rules/ as a candidate surface and records whether support is native, explicitly configured, tool-specific, or unproven.
  • The multi-host analysis identifies which artifacts can be shared, which require projections, and which existing files must remain untouched.
  • Claude's AGENTS.md versus CLAUDE.md precedence and fallback are documented.
  • The #619 ownership boundary is preserved: AIDD manages only its explicit block and does not impose global parity on user-owned content.
  • The result states whether the gap is absent, documentary, partially covered, or architectural.
  • The result defines a preserve-first policy for existing repositories.
  • The result defines a portable-first policy for new artifacts only when discovery, format, and semantics are compatible across all selected hosts.
  • The result explicitly rejects automatic migration and duplicate creation without demonstrated host need.
  • The result explicitly rejects inventing .agents/rules/ as a universal standard without sufficient host evidence.
  • The result recommends the smallest justified follow-up.

Prior art in this repo

Out of scope

  • Defining a new AIDD global installer or reopening the implementation work in #859.
  • Forcing all AIDD artifacts to be repository-scoped.
  • Duplicating framework-owned artifacts in a repository when they are correctly available at supported user/global scope.
  • Moving all artifacts under .agents/.
  • Inventing .agents/rules/ as a universal AIDD standard before the spike establishes sufficient host support.
  • Automatic migration of CLAUDE.md, skills, agents, or rules.
  • Global synchronization of CLAUDE.md and AGENTS.md.
  • Deleting or merging user-owned artifacts.
  • Replacing #916, #913, or #914.
  • Implementing a new CLI abstraction before the spike establishes the contract.

QA

  • Verify the matrix against current official host documentation.
  • Inspect current main and all related issues and PRs.
  • Inspect community evidence for .agents/rules/ and distinguish proposals, implementations, and host-native contracts.
  • Exercise clean/new and existing-repository fixtures across multiple selected-host combinations.
  • Confirm that no unnecessary logical duplicate is created.
  • Confirm that required host-native projections remain available.
  • Record evidence, host versions, exact paths, community sources, and unresolved uncertainties.
主要语言
TypeScript
星标
481
派生
45
平均合并
18 小时 31 分钟
30 天内合并 PR
108

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ai-driven-dev/framework 的其他 Issue

查看 ai-driven-dev/framework 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。