Skip to content

Commit

Permalink
feat(template): remove rarely used template files (#106)
Browse files Browse the repository at this point in the history
Signed-off-by: Steffen Exler <Steffen.Exler@mail.schwarz>
  • Loading branch information
linuxluigi committed Apr 30, 2022
1 parent 94d2c5b commit 888b843
Show file tree
Hide file tree
Showing 10 changed files with 7 additions and 22 deletions.
2 changes: 0 additions & 2 deletions _template/.dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@ out/

# docs
api/
docs/
**/*.md

# other files not needed for build
deployments/
.editorconfig
.golangci.yml
Makefile
Expand Down
Empty file removed _template/assets/.gitkeep
Empty file.
Empty file removed _template/configs/.gitkeep
Empty file.
Empty file removed _template/deployments/.gitkeep
Empty file.
19 changes: 0 additions & 19 deletions _template/docs/architecture/0001-record-architecture-decisions.md

This file was deleted.

Empty file removed _template/internal/.gitkeep
Empty file.
3 changes: 3 additions & 0 deletions _template/internal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `/internal`

Private application and library code. This is the code you don't want others importing in their applications or libraries. Note that this layout pattern is enforced by the Go compiler itself. See the Go 1.4 [`release notes`](https://golang.org/doc/go1.4#internalpackages) for more details. Note that you are not limited to the top level `internal` directory. You can have more than one `internal` directory at any level of your project tree.
Empty file removed _template/pkg/.gitkeep
Empty file.
3 changes: 3 additions & 0 deletions _template/pkg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `/pkg`

Library code that's ok to use by external applications (e.g., `/pkg/mypubliclib`). Other projects will import these libraries expecting them to work, so think twice before you put something here :-) Note that the `internal` directory is a better way to ensure your private packages are not importable because it's enforced by Go. The `/pkg` directory is still a good way to explicitly communicate that the code in that directory is safe for use by others. The [`I'll take pkg over internal`](https://travisjeffery.com/b/2019/11/i-ll-take-pkg-over-internal/) blog post by Travis Jeffery provides a good overview of the `pkg` and `internal` directories and when it might make sense to use them.
2 changes: 1 addition & 1 deletion embed_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 888b843

Please sign in to comment.