From d9188f4dfa0bdcd8c7b4bece454136f611ccdd29 Mon Sep 17 00:00:00 2001 From: Kyle Quest Date: Fri, 28 Dec 2018 13:32:23 -0800 Subject: [PATCH] internal package use clarifications --- internal/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/README.md b/internal/README.md index 5bba3ac..5442d3e 100644 --- a/internal/README.md +++ b/internal/README.md @@ -2,4 +2,4 @@ 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`).