diff options
| author | Jamal Carvalho <jamalcarvalho@google.com> | 2020-12-14 14:15:12 -0500 |
|---|---|---|
| committer | Jamal Carvalho <jamalcarvalho@google.com> | 2020-12-15 15:18:21 +0000 |
| commit | dd491678bb40cbe27fb740e2aa579dc1ffd88eb2 (patch) | |
| tree | c09a07c4f24b261725c56eb73d001e32cf905526 /go.dev | |
| parent | ce0efef06a59cfa7929785bed2e5cecbeb9f4979 (diff) | |
| download | go-x-website-dd491678bb40cbe27fb740e2aa579dc1ffd88eb2.tar.xz | |
[x/go.dev] content/about.md: add best practices section
Adds best practices section to be linked to from
the right sidebar on pkg.go.dev
Change-Id: I2ba4ab98c89c13257447f1306294838026a4cab4
X-GoDev-Commit: 0984db241fdfdb1d4e65c87b1afe63042a3a9c48
Diffstat (limited to 'go.dev')
| -rw-r--r-- | go.dev/content/about.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/go.dev/content/about.md b/go.dev/content/about.md index 312750eb..65af86e8 100644 --- a/go.dev/content/about.md +++ b/go.dev/content/about.md @@ -39,6 +39,24 @@ It’s important to write a good summary of the package in the first sentence of Pkg.go.dev displays the GOOS and GOARCH for the documentation displayed at the bottom of the documentation page. +## Best practices + +Pkg.go.dev surfaces details about Go packages and modules in order to help provide guidelines for best practices with Go. + +Here are the details we surface: + +* Has go.mod file + * The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go. A module version is defined by a tree of source files, with a go.mod file in its root. [More information about the go.mod file](https://golang.org/cmd/go/#hdr-The_go_mod_file). + +* Permissive license + * Permissive licenses place minimal restrictions on how software can be used, modified, and redistributed. For more information on how pkg.go.dev determines if a license is permissive, see our [license policy](http://pkg.go.dev/license-policy). + +* Tagged version + * When the go get command resolves modules by default it prioritizes tagged versions. When no tagged versions exist, go get looks up the latest known commit. Modules with tagged versions give importers more predictable builds. See [semver.org](https://semver.org) and [Keeping Your Modules Compatible](https://blog.golang.org/module-compatibility) for more information. + +* Stable version + * Projects at v0 are assumed to be experimental. When a project reaches a stable version — major version v1 or higher — breaking changes must be done in a new major version. Stable versions give developers the confidence that breaking changes won’t occur when they upgrade a package to the latest minor version. See [Go Modules: v2 and Beyond](https://blog.golang.org/v2-go-modules) for more information. + ## Creating a badge The pkg.go.dev badge provides a way for Go users to learn about the pkg.go.dev page associated with a given Go package or module. You can create a badge using the [badge generation tool](https://pkg.go.dev/badge). The tool will generate html and markdown snippets that you can use on your project website or in a README file. |
