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

Refactor directory structure #68

Closed
Tracked by #75
ianlewis opened this issue May 19, 2022 · 0 comments · Fixed by #118
Closed
Tracked by #75

Refactor directory structure #68

ianlewis opened this issue May 19, 2022 · 0 comments · Fixed by #118
Labels
type:refactor A cleanup or refactor

Comments

@ianlewis
Copy link
Member

ianlewis commented May 19, 2022

I was thinking about where was best to put builders long term. A couple of options were

  • internal/builders/* : builder code is generally not meant to be imported so this might make the most sense?
  • cmd/* : Where provenance-only is currently. This seems like a common pattern but seems arbitrary. Not sure I like it.
  • builders/* : Where go is currently. This is ok, but code is importable.

I kind of like the idea of putting main packages under a .../cmd/ structure so maybe this is also an option but maybe I'm overthinking it.

  • internal/cmd/{go-builder,python-builder,slsa-builder,...}: commands
  • internal/builders/{go,python,slsa,...}: supporting build code

I think the most important thing is just to be consistent with our structure.

@ianlewis ianlewis added the type:refactor A cleanup or refactor label May 19, 2022
@ianlewis ianlewis added this to the v1 milestone May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:refactor A cleanup or refactor
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant