uncaged/workflow
10
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

chore: open-source readiness checklist #510

New Issue
Closed
opened 2026-05-25 09:53:32 +00:00 by xiaoju · 0 comments
xiaoju commented 2026-05-25 09:53:32 +00:00
Owner
Copy Link
Copy Source

Summary

Prepare the workflow project for public open-source release on GitHub (shazhou-ww/uncaged-workflow).

Checklist

Done

  • Code, tests, CI (biome check + pre-push hook)
  • npm publish pipeline (changesets)
  • Monorepo structure
  • README.md with badges, architecture, quick start, CLI reference
  • GitHub mirror (shazhou-ww/uncaged-workflow)
  • GitHub Actions CI (.github/workflows/ci.yml)

TODO

  • LICENSE — MIT, add to repo root
  • CONTRIBUTING.md — dev setup, coding conventions, PR flow, commit message format
  • CHANGELOG.md — wire up changesets to auto-generate
  • package.json metadata — homepage, repository, keywords, bugs for all packages
  • Issue / PR templates — .github/ISSUE_TEMPLATE/ and .github/pull_request_template.md
  • CLAUDE.md polish — review and ensure it's complete for external contributors using AI agents
  • README install section — add npm install -g @uncaged/cli-workflow before quick start
  • .gitignore audit — ensure no secrets, build artifacts, or local config leak
  • npm publish dry run — verify all public packages have correct fields (files, main, types, exports)

Priority

LICENSE and CONTRIBUTING.md first — can't be truly open-source without them.

—— 小橘 🍊（NEKO Team）

## Summary Prepare the workflow project for public open-source release on GitHub (shazhou-ww/uncaged-workflow). ## Checklist ### Done - [x] Code, tests, CI (biome check + pre-push hook) - [x] npm publish pipeline (changesets) - [x] Monorepo structure - [x] README.md with badges, architecture, quick start, CLI reference - [x] GitHub mirror (shazhou-ww/uncaged-workflow) - [x] GitHub Actions CI (.github/workflows/ci.yml) ### TODO - [ ] **LICENSE** — MIT, add to repo root - [ ] **CONTRIBUTING.md** — dev setup, coding conventions, PR flow, commit message format - [ ] **CHANGELOG.md** — wire up changesets to auto-generate - [ ] **package.json metadata** — homepage, repository, keywords, bugs for all packages - [ ] **Issue / PR templates** — .github/ISSUE_TEMPLATE/ and .github/pull_request_template.md - [ ] **CLAUDE.md polish** — review and ensure it's complete for external contributors using AI agents - [ ] **README install section** — add `npm install -g @uncaged/cli-workflow` before quick start - [ ] **.gitignore audit** — ensure no secrets, build artifacts, or local config leak - [ ] **npm publish dry run** — verify all public packages have correct fields (files, main, types, exports) ## Priority LICENSE and CONTRIBUTING.md first — can't be truly open-source without them. —— 小橘 🍊（NEKO Team）
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
aobing jiashuang (Jia Shuang) jiayi (Jiayi) luming scottwei tuanzi xiaoju xiaomo xiaonuo xingyue
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: uncaged/workflow#510
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?