uptrace/bun

Improve documentation on NewCreateIndex

Ouverte

#1 290 ouverte le 28 oct. 2025

Voir sur GitHubGuide contributeur
 (7 commentaires) (0 réaction) (0 personne assignée)Go (279 forks)user submission
documentationgood first issueno stalebotstale

Métriques du dépôt

Stars
 (4 826 étoiles)
Métriques de merge PR
 (Merge moyen 76j 17h) (1 PR mergée en 30 j)

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!

Guide contributeur

Direction de recherche
Examinez la fonction NewCreateIndex dans le code source de bun, étudiez les tests et les modèles de documentation existants, puis ajoutez des exemples complets montrant la création d'index complexes avec le SQL correspondant.
Stack technique
go
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75