uptrace/bun

Improve documentation on NewCreateIndex

Open

#1,290 创建于 2025年10月28日

在 GitHub 查看
 (7 评论) (0 反应) (0 负责人)Go (4,826 star) (279 fork)user submission
documentationgood first issueno stalebotstale

描述

Hi, I'm creating indexes with the ORM, and it's all good, but it took a lot of searching and some trial and error. The documentation seems very poor about this, I believe a few complex examples with the NewCreateIndex function would help a lot, especially with the counterpart SQL code.

Thanks!

贡献者指南

技术栈
gosql
领域
documentationbackend
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Go programmingSQL knowledgebun ORM basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
Examine the existing documentation for CreateIndex and NewCreateIndex in the bun repository (likely in the docs folder or README). Look at the current examples and compare with the actual SQL output generated by the ORM. Consider adding examples for composite indexes, unique indexes, and indexes with conditions. Include the corresponding SQL statements generated by bun for each example. Coordinate with maintainers to ensure consistency with the codebase.
Improve documentation on NewCreateIndex · uptrace/bun#1290 | Good First Issue