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

Improve documentation on folder structure #15

Open
brumhard opened this issue Oct 3, 2021 · 0 comments
Open

Improve documentation on folder structure #15

brumhard opened this issue Oct 3, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@brumhard
Copy link
Contributor

brumhard commented Oct 3, 2021

Documentation on the following topics/ questions should be improved:

  • why was this structure chosen
  • how to use the folder structure (what should be put where)
  • disclaimer that the structure should not be enforced if it doesn't fit the project but can be used as default
  • where do the other config files come from (Makefile, .golangci.yml, etc.)
@brumhard brumhard added proposal Feature request documentation Improvements or additions to documentation and removed proposal Feature request labels Oct 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant