coze-dev / coze-dev/coze-studio
Document dev setup steps instead of relying only on a single script(希望在文档中列出开发环境搭建的显式步骤,而不只依赖单一脚本)
- Dominant language
- TypeScript
- Stars
- 21.6k
- Forks
- 3.1k
- PR merge metrics
- No merged PRs in 30d
Description
Hi, thanks for the project!
Right now the dev environment seems to be set up mainly via a single script (e.g. `make debug`). This is convenient, but as a contributor it’s hard to see exactly what steps are being taken (which dependencies are installed, where files are written, etc.), and it increases the cognitive load when trying to understand or customize the setup.
Could you please:
- Document the dev setup as explicit, step-by-step commands in the README/docs (so we can run them manually if we prefer), and
- Briefly explain what the script does and where it writes/downloads files?
Optional, but nice to have:
- A `--dry-run` / `--verbose` mode to show the underlying commands.
This would make the project much more friendly to contributors and easier to audit and debug. I’d be happy to help draft such a section if needed. Thanks!
---
你好,感谢你们维护这个项目!
目前开发环境主要通过一个脚本(例如 `make debug`)来完成搭建,这对快速上手很方便,但对希望参与维护或深入了解项目的贡献者来说,脚本内部做了哪些事(安装了哪些依赖、往哪里写文件)不太直观,心智负担会比较大,也不便于审计和调试。
能否考虑:
- 在 README / 文档中以“逐步命令”的方式写清楚开发环境的搭建步骤(让大家可以选择手动执行这些命令,而不是只能跑脚本),以及
- 简单说明脚本会做哪些操作、会往哪些路径写入/下载内容?
如果还能提供 `--dry-run` / `--verbose` 之类的参数,打印出将要执行的命令,就更理想了。
这样可以让项目对贡献者更加友好,也更容易排查问题。如果你们觉得有价值,我也愿意帮忙一起完善相关文档。谢谢!
Contributor guide
Research direction
Start by locating the implementation behind `make debug`, then inspect the README/docs and record the commands, dependencies, and paths it uses. Done means the documentation provides reproducible step-by-step setup instructions and briefly explains the script's actions and file locations; the optional dry-run or verbose mode is not required by the core request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100