go/project-layout
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

internal package use clarifications

Browse Source
This commit is contained in:
Kyle Quest 2018-12-28 13:32:23 -08:00
parent 4090445807
commit d9188f4dfa
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
internal/README.md
View File

@ -2,4 +2,4 @@
Private application and library code. This is the code you don't want others importing in their applications or libraries. Private application and library code. This is the code you don't want others importing in their applications or libraries.
Put your actual application code in the `/internal/app` directory (e.g., `/internal/app/myapp`) and the code shared by those apps in the `/internal/pkg` directory (e.g., `/internal/pkg/myprivlib`). You can optionally add a bit of extra structure to your internal packages to separate your shared and non-shared internal code. It's not required, but it's nice to have visual clues showing the intended package use. Your actual application code can go in the `/internal/app` directory (e.g., `/internal/app/myapp`) and the code shared by those apps in the `/internal/pkg` directory (e.g., `/internal/pkg/myprivlib`).