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

[Core] Follow industry standards for Golang project folder structure #379

Open
4 tasks
Olshansk opened this issue Dec 5, 2022 · 1 comment
Open
4 tasks
Assignees
Labels
code health Nice to have code improvement core Core infrastructure - protocol related documentation Improvements or additions to documentation

Comments

@Olshansk
Copy link
Member

Olshansk commented Dec 5, 2022

Objective

Follow standard Golang library code practices.

Origin Document

@Gustavobelfort suggested we follow standard project layouts in our V1 repo: https://github.com/golang-standards/project-layout

Screenshot 2022-12-05 at 11 26 31 AM

Goals

  • Make the codebase follow best practices in the industry
  • Make the codebase easily approachable/navigatable for newcomers

Deliverable

Non-goals / Non-deliverables

  • New features
  • Business logic modifications

General issue deliverables

  • Update the appropriate CHANGELOG
  • Update any relevant READMEs (local and/or global)
  • Update any relevant global documentation & references

Testing Methodology

  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @Olshansk
Co-Owners: @Gustavobelfort

@Olshansk Olshansk added documentation Improvements or additions to documentation core Core infrastructure - protocol related labels Dec 5, 2022
@Olshansk Olshansk moved this to Backlog in V1 Dashboard Dec 5, 2022
@jessicadaugherty jessicadaugherty moved this from Backlog to Up Next in V1 Dashboard Dec 19, 2022
@Gustavobelfort Gustavobelfort moved this from Up Next to In Progress in V1 Dashboard Dec 22, 2022
@Gustavobelfort Gustavobelfort linked a pull request Dec 26, 2022 that will close this issue
16 tasks
@Gustavobelfort Gustavobelfort moved this from In Progress to In Review in V1 Dashboard Dec 27, 2022
@Olshansk
Copy link
Member Author

Olshansk commented Feb 7, 2023

A first attempt at this was made in #412 but is no longer a priority due to other work. It should still be used as direction for anyone who picks this up in the future. Specifically:

  • Mimic the same list of changes as in the previous PR
  • Move internal code to an internal directory to be compliant with other go extensions
  • Use git mv to track changes easier
  • Do not rename app/client to cmd/v1, but potentially just cmd or cli instead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Nice to have code improvement core Core infrastructure - protocol related documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

Successfully merging a pull request may close this issue.

2 participants