Browse Source

internal package use clarifications

chore/proposed-structure
Kyle Quest 7 years ago
parent
commit
d9188f4dfa
1 changed files with 1 additions and 1 deletions
  1. +1
    -1
      internal/README.md

+ 1
- 1
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`).

Loading…
Cancel
Save