docs: 细化维护者指南 #225
docs: 细化维护者指南 #225
Conversation
WalkthroughThe document Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
docs/maintainer-guide.md (4)
53-61: Enhance clarity of publishing stepsConsider the following improvements to make the steps more foolproof:
- Add a prerequisite step to verify npm login status (
npm whoami)- Clarify step 5 with a complete example:
5. 修改环境变量`TINY_SCOPE=xxx` (第一步中替换的结果, 但是不要包含@) 1. 例如 `@foo/tiny-toolkit-pro`，TINY_SCOPE应该是`foo`而不是`@foo` + 2. 完整示例: 如果您的包名是 `@john/tiny-toolkit-pro`，则设置 `TINY_SCOPE=john`- Add explanation for steps 7-8:
7. `rm -rf ~/.tiny` + # 清除缓存以确保新的scope设置生效 8. `tiny init pro` + # 使用新的scope初始化环境
53-61: Improve environment variable section formattingConsider using a more prominent warning box format:
-> ⚠️ 重要提示 -> -> 修改环境变量后必须重启终端才能生效。这是一个常见的错误来源。 -> -> 各操作系统的环境变量设置指南： -> - [Linux 环境变量指南](https://wiki.archlinuxcn.org/wiki/%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F) -> - [Windows 环境变量指南](https://support.esri.com/zh-cn/knowledge-base/edit-an-environment-variable-1462478594981-000002146) -> - [macOS 环境变量指南](https://support.apple.com/zh-cn/guide/terminal/apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac)This format provides better visual hierarchy and makes the warning more noticeable.
53-61: Enhance safety checks in publishing checklistsConsider adding these important verification steps to both checklists:
+- [ ] 已验证 npm 登录状态 (`npm whoami`) +- [ ] 已验证包的内容 (`npm pack` 并检查 .tgz 文件内容) +- [ ] 已在新的终端验证环境变量设置 (`echo $TINY_SCOPE`)These additional checks will help prevent common publishing mistakes.
53-61: Consider adding a troubleshooting sectionThe guide would benefit from a troubleshooting section that addresses common issues:
## 常见问题排查 ### 发布失败 - 确认 npm 登录状态 - 检查包名是否已被占用 - 验证 package.json 中的版本号 ### 环境变量问题 - 确认环境变量格式正确 - 验证终端已重启 - 检查 TINY_SCOPE 值 ### 初始化失败 - 确认 ~/.tiny 目录已清理 - 验证 CLI 工具安装正确This would help users resolve common issues independently.
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit