Add note about including version numbers

twpayne · Jun 20, 2019 · 5bdbde1 · 5bdbde1
1 parent 8467697
commit 5bdbde1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -85,6 +85,14 @@ To run a local "snapshot" build without publishing:
 
 If you plan to package chezmoi for your distibution, then note:
 
+* Please set the version number, git commit, and build time in the binary. This is done by passing the linker flags:
+
+  ```
+  -X github.com/twpayne/chezmoi/cmd.VersionStr={{ .Version }}
+  -X github.com/twpayne/chezmoi/cmd.Commit={{ .Commit }}
+  -X github.com/twpayne/chezmoi/cmd.Date={{ .Date }}
+  ```
+
 * Please enable CGO, if possible. chezmoi can be built and run without CGO, but
   the `.chezmoi.group` template variable may not be set on some systems.