Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#49 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
22/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github, javascript
Lĩnh vực
backend-api-design, developer-experience

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
JavaScript
Star
22
Fork
3
Merge trung bình
27 phút
Pull request đã merge (30 ngày)
27

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của egdev6/github-repository-bootstrap

Tất cả issue của egdev6/github-repository-bootstrap

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.