Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get your refactor/hygience/tech debt proposals in by 12/2, tag them "refactor" #184

Open
hannahhoward opened this issue Nov 18, 2024 · 3 comments

Comments

@hannahhoward
Copy link
Member

No description provided.

@hannahhoward hannahhoward converted this from a draft issue Nov 18, 2024
@travis travis moved this from Sprint Backlog to In Progress in Storacha Project Planning Dec 2, 2024
@volmedo
Copy link
Member

volmedo commented Dec 4, 2024

this is the (Go) way!

Go is a very opinionated language and the community has clear ideas about how idiomatic Go code looks like. This has the advantage of removing a lot of bikeshedding when it comes to code style and also makes new code bases more approachable as reading the code is easy and you only need to focus on the logic.

We could make our Go repos more welcoming to new devs by looking for opportunities to make our code more idiomatic. Some examples I came across after working a bit on the indexing-service repo would be:

  • use generics only when they add value (some times a bit of duplication is better than complex types)
  • define interfaces only when needed

We can decide if getting a full task out of this is the best use of our time, or it's something we can do as drive-by changes when working on other things.

@BravoNatalie
Copy link

While working on the w3infra repo, I noticed that the DynamoDB table usage has different implementations across our packages. I believe it’d be helpful to standardize this to make things easier for new developers and simplify debugging. It’s not a top priority right now, but I think it’s worth adding to the backlog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants