docs: add a README to @relkit/cli

未关闭 适合新手
#176 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
90/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
bun, typescript
领域
documentation

调研方向

阅读 WRITING.md,并以 packages/relkit/README.md 为范本。添加 packages/cli/README.md,介绍 relkit 命令及其 dev、check、build、add、deploy、migrate 和 mcp 命令、安装方式,以及 CLI 参考文档链接。运行 bun run check;检查通过且 README 已准备好在发布后于 npm 上显示时,任务即完成。

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

描述

documentation good first issue

packages/cli has no README.md, so the package page on npm is empty.

What to do

  • Add packages/cli/README.md with: what @relkit/cli is (the relkit command: dev, check,
    build, add, deploy, migrate, mcp), how to install it, and a link to the
    CLI reference.
  • Use the product name RelKit in prose and follow WRITING.md.

Done when bun run check passes and the README renders on the package page after the next
release. packages/relkit/README.md is a good model.

主要语言
TypeScript
星标
1
派生
0
平均合并
2 小时 45 分钟
30 天内合并 PR
64

环境准备

从这里开始

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

rel-kit/relkit 的其他 Issue

查看 rel-kit/relkit 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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