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

feat(template): Remove rarely used template files #106

Merged
merged 1 commit into from
Apr 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.

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.