octokit / go-sdk

A generated Go SDK from GitHub's OpenAPI specification.
MIT License
57 stars 7 forks source link

[DOCS]: Understanding the import aliases #70

Open coquer opened 2 months ago

coquer commented 2 months ago

Describe the need

Hi team, I came across your code, and I would love to understand why you use hashes to alias your imports:

    i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91 "github.com/microsoft/kiota-abstractions-go/serialization"
    i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6 "github.com/octokit/go-sdk/pkg/github/models"
)

SDK Version

No response

API Version

No response

Code of Conduct

github-actions[bot] commented 2 months ago

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

kfcampbell commented 2 months ago

Hi! That's an artifact of the generation tooling we use, Kiota. You'd have to ask over there to be sure. My guess is that they do it because hashes are easy to machine-generate in a way that guarantees collision avoidance, which isn't always true for human-readable names.