feat: Add golang template and first Makefile

AntiD2ta · AntiD2ta · commit f71f7cef7f06 · 2022-01-06T15:05:45.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.keep
diff --git a/Makefile b/Makefile
@@ -0,0 +1,4 @@
+.DEFAULT_GOAL 	:= help
+
+help: ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
diff --git a/api/README.md b/api/README.md
@@ -0,0 +1,8 @@
+# `/api`
+
+OpenAPI/Swagger specs, JSON schema files, protocol definition files.
+
+Examples:
+
+* https://github.com/kubernetes/kubernetes/tree/master/api
+* https://github.com/moby/moby/tree/master/api
diff --git a/assets/README.md b/assets/README.md
@@ -0,0 +1,3 @@
+# `/assets`
+
+Other assets to go along with your repository (images, logos, etc).
diff --git a/build/README.md b/build/README.md
@@ -0,0 +1,11 @@
+# `/build`
+
+Packaging and Continuous Integration.
+
+Put your cloud (AMI), container (Docker), OS (deb, rpm, pkg) package configurations and scripts in the `/build/package` directory.
+
+Put your CI (travis, circle, drone) configurations and scripts in the `/build/ci` directory. Note that some of the CI tools (e.g., Travis CI) are very picky about the location of their config files. Try putting the config files in the `/build/ci` directory linking them to the location where the CI tools expect them when possible (don't worry if it's not and if keeping those files in the root directory makes your life easier :-)).
+
+Examples:
+
+* https://github.com/cockroachdb/cockroach/tree/master/build
diff --git a/cmd/README.md b/cmd/README.md
@@ -0,0 +1,19 @@
+# `/cmd`
+
+Main applications for this project.
+
+The directory name for each application should match the name of the executable you want to have (e.g., `/cmd/myapp`).
+
+Don't put a lot of code in the application directory. If you think the code can be imported and used in other projects, then it should live in the `/pkg` directory. If the code is not reusable or if you don't want others to reuse it, put that code in the `/internal` directory. You'll be surprised what others will do, so be explicit about your intentions!
+
+It's common to have a small `main` function that imports and invokes the code from the `/internal` and `/pkg` directories and nothing else.
+
+Examples:
+
+* https://github.com/heptio/ark/tree/master/cmd (just a really small `main` function with everything else in packages)
+* https://github.com/moby/moby/tree/master/cmd
+* https://github.com/prometheus/prometheus/tree/master/cmd
+* https://github.com/influxdata/influxdb/tree/master/cmd
+* https://github.com/kubernetes/kubernetes/tree/master/cmd
+* https://github.com/dapr/dapr/tree/master/cmd
+* https://github.com/ethereum/go-ethereum/tree/master/cmd
diff --git a/configs/README.md b/configs/README.md
@@ -0,0 +1,5 @@
+# `/configs`
+
+Configuration file templates or default configs.
+
+Put your `confd` or `consul-template` template files here.
diff --git a/deployments/README.md b/deployments/README.md
@@ -0,0 +1,3 @@
+# `/deployments`
+
+IaaS, PaaS, system and container orchestration deployment configurations and templates (docker-compose, kubernetes/helm, mesos, terraform, bosh).
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,9 @@
+# `/docs`
+
+Design and user documents (in addition to your godoc generated documentation).
+
+Examples:
+
+* https://github.com/gohugoio/hugo/tree/master/docs
+* https://github.com/openshift/origin/tree/master/docs
+* https://github.com/dapr/dapr/tree/master/docs
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,10 @@
+# `/examples`
+
+Examples for your applications and/or public libraries.
+
+Examples:
+
+* https://github.com/nats-io/nats.go/tree/master/examples
+* https://github.com/docker-slim/docker-slim/tree/master/examples
+* https://github.com/gohugoio/hugo/tree/master/examples
+* https://github.com/hashicorp/packer/tree/master/examples
diff --git a/init/README.md b/init/README.md
@@ -0,0 +1,3 @@
+# `/init`
+
+System init (systemd, upstart, sysv) and process manager/supervisor (runit, supervisord) configs.
diff --git a/internal/README.md b/internal/README.md
@@ -0,0 +1,20 @@
+# `/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.
+
+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 (especially for smaller projects), 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`).
+
+Examples:
+
+* https://github.com/hashicorp/terraform/tree/master/internal
+* https://github.com/influxdata/influxdb/tree/master/internal
+* https://github.com/perkeep/perkeep/tree/master/internal
+* https://github.com/jaegertracing/jaeger/tree/master/internal
+* https://github.com/moby/moby/tree/master/internal
+* https://github.com/satellity/satellity/tree/master/internal
+
+## `/internal/pkg`
+
+Examples:
+
+* https://github.com/hashicorp/waypoint/tree/main/internal/pkg
diff --git a/pkg/README.md b/pkg/README.md
@@ -0,0 +1,59 @@
+# `/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.
+
+It's also a way to group Go code in one place when your root directory contains lots of non-Go components and directories making it easier to run various Go tools (as mentioned in these talks: [`Best Practices for Industrial Programming`](https://www.youtube.com/watch?v=PTE4VJIdHPg) from GopherCon EU 2018, [GopherCon 2018: Kat Zien - How Do You Structure Your Go Apps](https://www.youtube.com/watch?v=oL6JBUk6tj0) and [GoLab 2018 - Massimiliano Pippi - Project layout patterns in Go](https://www.youtube.com/watch?v=3gQa1LWwuzk)).
+
+Note that this is not a universally accepted pattern and for every popular repo that uses it you can find 10 that don't. It's up to you to decide if you want to use this pattern or not. Regardless of whether or not it's a good pattern more people will know what you mean than not. It might a bit confusing for some of the new Go devs, but it's a pretty simple confusion to resolve and that's one of the goals for this project layout repo.
+
+Ok not to use it if your app project is really small and where an extra level of nesting doesn't add much value (unless you really want to). Think about it when it's getting big enough and your root directory gets pretty busy (especially if you have a lot of non-Go app components).
+
+The `pkg` directory origins: The old Go source code used to use `pkg` for its packages and then various Go projects in the community started copying the pattern (see [`this`](https://twitter.com/bradfitz/status/1039512487538970624) Brad Fitzpatrick's tweet for more context).
+
+
+Examples:
+
+* https://github.com/prometheus/prometheus/tree/master/pkg
+* https://github.com/jaegertracing/jaeger/tree/master/pkg
+* https://github.com/istio/istio/tree/master/pkg
+* https://github.com/GoogleContainerTools/kaniko/tree/master/pkg
+* https://github.com/google/gvisor/tree/master/pkg
+* https://github.com/google/syzkaller/tree/master/pkg
+* https://github.com/perkeep/perkeep/tree/master/pkg
+* https://github.com/minio/minio/tree/master/pkg
+* https://github.com/heptio/ark/tree/master/pkg
+* https://github.com/argoproj/argo/tree/master/pkg
+* https://github.com/heptio/sonobuoy/tree/master/pkg
+* https://github.com/helm/helm/tree/master/pkg
+* https://github.com/kubernetes/kubernetes/tree/master/pkg
+* https://github.com/kubernetes/kops/tree/master/pkg
+* https://github.com/moby/moby/tree/master/pkg
+* https://github.com/grafana/grafana/tree/master/pkg
+* https://github.com/influxdata/influxdb/tree/master/pkg
+* https://github.com/cockroachdb/cockroach/tree/master/pkg
+* https://github.com/derekparker/delve/tree/master/pkg
+* https://github.com/etcd-io/etcd/tree/master/pkg
+* https://github.com/oklog/oklog/tree/master/pkg
+* https://github.com/flynn/flynn/tree/master/pkg
+* https://github.com/jesseduffield/lazygit/tree/master/pkg
+* https://github.com/gopasspw/gopass/tree/master/pkg
+* https://github.com/sosedoff/pgweb/tree/master/pkg
+* https://github.com/GoogleContainerTools/skaffold/tree/master/pkg
+* https://github.com/knative/serving/tree/master/pkg
+* https://github.com/grafana/loki/tree/master/pkg
+* https://github.com/bloomberg/goldpinger/tree/master/pkg
+* https://github.com/Ne0nd0g/merlin/tree/master/pkg
+* https://github.com/jenkins-x/jx/tree/master/pkg
+* https://github.com/DataDog/datadog-agent/tree/master/pkg
+* https://github.com/dapr/dapr/tree/master/pkg
+* https://github.com/cortexproject/cortex/tree/master/pkg
+* https://github.com/dexidp/dex/tree/master/pkg
+* https://github.com/pusher/oauth2_proxy/tree/master/pkg
+* https://github.com/pdfcpu/pdfcpu/tree/master/pkg
+* https://github.com/weaveworks/kured/tree/master/pkg
+* https://github.com/weaveworks/footloose/tree/master/pkg
+* https://github.com/weaveworks/ignite/tree/master/pkg
+* https://github.com/tmrts/boilr/tree/master/pkg
+* https://github.com/kata-containers/runtime/tree/master/pkg
+* https://github.com/okteto/okteto/tree/master/pkg
+* https://github.com/solo-io/squash/tree/master/pkg
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,11 @@
+# `/scripts`
+
+Scripts to perform various build, install, analysis, etc operations.
+
+These scripts keep the root level Makefile small and simple.
+
+Examples:
+
+* https://github.com/kubernetes/helm/tree/master/scripts
+* https://github.com/cockroachdb/cockroach/tree/master/scripts
+* https://github.com/hashicorp/terraform/tree/master/scripts
diff --git a/test/README.md b/test/README.md
@@ -0,0 +1,9 @@
+# `/test`
+
+Additional external test apps and test data. Feel free to structure the `/test` directory anyway you want. For bigger projects it makes sense to have a data subdirectory. For example, you can have `/test/data` or `/test/testdata` if you need Go to ignore what's in that directory. Note that Go will also ignore directories or files that begin with "." or "_", so you have more flexibility in terms of how you name your test data directory.
+
+Examples:
+
+* https://github.com/openshift/origin/tree/master/test (test data is in the `/testdata` subdirectory)
+
+
diff --git a/third_party/README.md b/third_party/README.md
@@ -0,0 +1,3 @@
+# `/third_party`
+
+External helper tools, forked code and other 3rd party utilities (e.g., Swagger UI).
diff --git a/tools/README.md b/tools/README.md
@@ -0,0 +1,9 @@
+# `/tools`
+
+Supporting tools for this project. Note that these tools can import code from the `/pkg` and `/internal` directories.
+
+Examples:
+
+* https://github.com/istio/istio/tree/master/tools
+* https://github.com/openshift/origin/tree/master/tools
+* https://github.com/dapr/dapr/tree/master/tools
diff --git a/vendor/README.md b/vendor/README.md
@@ -0,0 +1,7 @@
+# `/vendor`
+
+Application dependencies (managed manually or by your favorite dependency management tool like the new built-in, but still experimental, [`modules`](https://github.com/golang/go/wiki/Modules) feature).
+
+Don't commit your application dependencies if you are building a library.
+
+Note that since [`1.13`](https://golang.org/doc/go1.13#modules) Go also enabled the module proxy feature (using `https://proxy.golang.org` as their module proxy server by default). Read more about it [`here`](https://blog.golang.org/module-mirror-launch) to see if it fits all of your requirements and constraints. If it does, then you won't need the 'vendor' directory at all.
diff --git a/web/README.md b/web/README.md
@@ -0,0 +1,3 @@
+# `/web`
+
+Web application specific components: static web assets, server side templates and SPAs.
diff --git a/website/README.md b/website/README.md
@@ -0,0 +1,8 @@
+# `/website`
+
+This is the place to put your project's website data if you are not using GitHub pages.
+
+Examples:
+
+* https://github.com/hashicorp/vault/tree/master/website
+* https://github.com/perkeep/perkeep/tree/master/website

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+# `/assets`
	`2`	`+`
	`3`	`+Other assets to go along with your repository (images, logos, etc).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+# `/deployments`
	`2`	`+`
	`3`	`+IaaS, PaaS, system and container orchestration deployment configurations and templates (docker-compose, kubernetes/helm, mesos, terraform, bosh).`