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

Consider refactoring the format of the repo to follow Go best practices, and have fewer items in the root directory #41

Open
echarrod opened this issue Aug 31, 2024 · 0 comments

Comments

@echarrod
Copy link

Hello,

Just had a bit of advice that would certainly help me understand the code better. It seems all the code is at the top level. In my opinion this is harder to read and understand as:

  1. Code isn't "categorised into areas", and I'm not sure where to find things
  2. You have to scroll down quite far to get to the README!
  3. packages can help follow the "single responsibility principle", rather than the whole repo doing everything.

I know I see the code is auto-generated by Crank, but hoping it's possible to find a solution that makes the code easier to digest.
Potentially following code such as https://github.com/golang-standards/project-layout would help 🙏

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

No branches or pull requests

1 participant