Skip to content

docs(contributing): clarify workspace setup, release scope, and PR handoffs - #152

Closed
xiaoland wants to merge 4 commits into
mainfrom
feat/ecosystem-contribution-dx
Closed

xiaoland wants to merge 4 commits into
mainfrom
feat/ecosystem-contribution-dx

Conversation

@xiaoland

@xiaoland xiaoland commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Intent and scope

Make workspace contribution prerequisites and release responsibilities explicit. Add the contribution guide, put the private UI package token/ACL prerequisite before installation, distinguish implementation scope from Changeset release selection, and add next-responder and outstanding-delivery fields to the local PR template.

Document the eventual public-tarball transition: preserve package.json semver and change the exact-version root override and lockfile only after the public artifact exists.

Primary scope: contributing. Release projects: none.
Tracking issue: InKCre/.github#39.

Validation evidence

  • Targeted oxfmt --check and diff whitespace checks passed; the handoff template was checked again after its update.
  • Instructions were checked against workspace scripts, Changesets, and package configuration.
  • An isolated copy of this head consumed both locked UI versions (2.3.0 and 2.5.0) through loopback HTTP with an empty store, no tokens, empty npm configs, and a frozen lockfile. Core SDK, Web, browser-extension, and all Extension builds passed; unrelated package resolutions were unchanged and the native Module Federation manifest passed inspection.
  • That experiment does not verify the final GitHub URL or real fork CI. No dependency or lockfile migration is included here; no full local workspace check was claimed for the documentation-only change.

Next action

@xiaoland coordinates contribution-guide and template review. After the original UI tarball is publicly downloadable and anonymously verified, submit the consumer override/lockfile migration and verify real fork CI. Current private-package prerequisites still apply.

Delivery effects

No package publication, deployment, migration, or credential modification. Template changes become active after merging. The contribution guide and handoff template are ready for review; public-consumer migration remains a separate delivery step.

Stack

Parent: none. Children: none.
Related: .github#36, docs#40, impl-py#153, ui#64.

Risk and rollback

Do not remove the private-package access requirement before actual publication and consumer verification. Revert these documentation/template changes to restore the prior guidance.

- 说明私有 UI 包权限、fork CI 与实际 setup 前提
- 区分实现项目命名和 Changeset 发布范围
- 记录公开 tarball 消费切换顺序,不改动有效 lockfile
- Ask for the needed feedback, next responder, and outstanding delivery work
- Link cross-repository changes to their tracking issue
@xiaoland xiaoland added the documentation Improvements or additions to documentation label Oct 26, 2026
@xiaoland xiaoland self-assigned this Oct 26, 2026
@xiaoland xiaoland changed the title docs(contributing): 明确工作区贡献与发布范围 docs(contributing): clarify workspace setup, release scope, and PR handoffs Oct 26, 2026
@xiaoland xiaoland moved this to Review / acceptance in InKCre Current Work Oct 26, 2026
- Preserve current main changes before reviewing contribution delivery.
@xiaoland

Copy link
Copy Markdown
Member Author

Continued in #171, which includes this contribution guide and handoff template together with the actual anonymous UI dependency cutover. The new PR comes from xiaoland/impl-ts; its five ordinary checks passed, including Workspace contract and both browser E2E lanes. Trusted previews were correctly skipped for the fork.

Closing this earlier documentation-only proposal as superseded so review and delivery can continue in one PR. This preserves the original discussion and does not merge either proposal. Tracking: InKCre/.github#39.

This branch was successfully deployed

1 active deployment
preview — 57e63e76 Deployed Oct 26, 2026 by xiaoland via Retire exact Pages preview #146
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

1 participant