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

Expose a read-only repository planning API with an injected command backend

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
22/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
github, javascript

调研方向

Read merged command transport PR #47 and minimal CLI fixture extraction PR #48, then inspect the native planning entry point and the CLI-2 characterization tests described in the issue. The issue says CLI-2 still needs an explicitly authorized bounded design and measurement attempt before implementation; verify the proposed unit fits the 400-line cap. Done means the full API contract, tests, and documentation pass the listed CLI-4 checks while preserving native behavior.

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

描述

enhancement

Expose a read-only repository planning API with an injected command backend

Goal and scope

Introduce executeRepositoryPlan(argv, { execute } = {}) for repository planning of labels, milestones, templates and files. This is a separate feature candidate, not an additional acceptance requirement for #15.

The native CLI remains the product entry for Projects and apply. Exclude mutations through the API, new schema/default/flag/version fields, workflow activation, branch-protection features, live credentials, sandbox guarantees and release changes. A supplied backend is trusted code, not a security sandbox.

Dependencies and coordination

Build on merged command transport PR #47 and merged minimal-CLI fixture extraction PR #48. These are delivered foundations, not outstanding issues; enabled-family/guard characterization is still CLI-2 work. Milestone and scheduling are deliberately unassigned; the approved B01→B06 order is unchanged. This issue is proposed, not a reservation or implementation grant. Recheck dependencies, assignees, claims and related PR before any explicit start.

Acceptance criteria

  • Plan all four supported resource families with the same target/config/observed/plan and canonical authorization kernel as the native CLI.
  • Reject apply, including authorized apply, before command-runner construction, config discovery or backend execution; an earlier rejection by the existing parser remains valid.
  • Validate/normalize actual config, reject an active Project before target/backend discovery, and prevent caller extras from bypassing this private policy.
  • Preserve legacy native Projects/apply behavior and ghJson(args, options)/ghTry(args, options) calling contracts.
  • Return a fresh { report, exitCode } per supported call, with 0/1 outcomes, no process exit or console transport, and no cross-call mutable backend state.
  • Cover import safety, native/default/injected backends, apply refusal, config/project policy, backend validation, command errors and malformed JSON, output freshness and sequential/concurrent isolation. Document argument/type boundaries rather than promising universal error capture.
  • Keep callback identity/private policy out of serialized config, plan and authorization hashes.
  • Verify the API selects only read/discovery requests and performs no product apply/file-write path. Disabled families issue no family-specific requests; global discovery may remain.

ODD phases

Phase Result Prerequisite Validation and exit
CLI-2 Characterize current native planning: enabled families, ensure/replace/noop, guards and disabled families Merged fixtures #48 Real CLI assertions cover existing behavior; all essential tests/docs fit a complete measured unit
CLI-3 Extract live private planning used immediately by native main CLI-2 Characterization remains green; no unused public factory or Project-policy branch
CLI-4 Deliver the complete public API and all new entry contracts/docs CLI-3 Functional contract matrix, regression checks and independent verification pass

Forecasts for CLI-2/3/4 are respectively 360–439, 100–150 and 320–370 changed lines. They are not measured fits, minimums or permission to write. CLI-2's forecast crosses the 400-line cap; actual fit is unproven. Its next gate is an explicitly authorized bounded design/measurement attempt, not source implementation. No cap exception or scope split is inferred from a forecast. Form and measure the whole proposed unit in RAM before writing anywhere; if it exceeds 400 additions+deletions, stop without compressing code, dropping assertions or deferring essential tests/docs. Moves count twice.

Delivery

Use meaningful test-first evidence where applicable, proportionate checks otherwise, and independent verification according to risk. Separate authorization remains necessary for implementation and each delivery operation. No hidden helpers, live API validation or release claim is implied.

主要语言
JavaScript
星标
22
派生
3
平均合并
27 分钟
30 天内合并 PR
27

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

egdev6/github-repository-bootstrap 的其他 Issue

查看 egdev6/github-repository-bootstrap 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

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