Advice for Effectively Making Contributions to GORM

[bruc3mackenzi3]

Hello all,

My name is Bruce and I'm a software developer based in Canada. I'm interested in contributing to GORM - specifically the documentation - and am starting this discussion about ways to approach this.

I'd like to hear from the maintainers how they prefer contributors to approach this work. For instance, do you welcome any improvements we ourselves identify, or prefer the work be coordinated upfront in some way, etc.

I've submitted a few PRs (here and here) so far and they haven't gained much traction. I'm eager to further contribute but it's ideal for open PRs to more along before I take on further changes.

I look forward to connecting with fellow members of the GORM community.

Warm regards,
Bruce MacKenzie

[jinzhu]

Hi @bruc3mackenzi3

Thank you for your post and contributions, and sorry for the delay, recently I am quite busy on some personal stuff, haven't contribute enough time to GORM, so only reviewed those PR all checks pass few times in the last 2 months.

Usually PR w/o question should be merged at most 1 month, but you can drop me an email or cc other maintainers to speed up the review.

For the document, I think you can start from anything that you feel most confusing from this website https://gorm.io/docs, and I am happy to clarify it, maybe we can use this thread or you can send me an email for any questions?

And if you are interested, I am happy to assign the maintenance permission of github.com/go-gorm/gorm.io to make sure those improvements be merged faster

Thank you :)

[bruc3mackenzi3]

Hi Jinzhu, thank you for the reply and providing clarity around contributing to GORM.

I will explore the GORM documentation site and find an area to start improving.

It would be great if I could get maintainer permissions on gorm.io. That would make contributing much easier.

[jinzhu]

Hi @bruc3mackenzi3

Assigned the permission to you, let me know if there are any other things block you.