uptrace/bun

Improve documentation on NewCreateIndex

Open

#1,290 opened on Oct 28, 2025

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Go (279 forks)user submission
documentationgood first issueno stalebotstale

Repository metrics

Stars
 (4,826 stars)
PR merge metrics
 (Avg merge 76d 17h) (1 merged PR in 30d)

Description

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!

Contributor guide

Research direction
Examine the NewCreateIndex function in the bun source code, study existing tests and documentation patterns, then add comprehensive examples showing complex index creation with corresponding SQL.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75