From c9e4653b891da2b466403cbe0c65bf622058ce96 Mon Sep 17 00:00:00 2001 From: Alex Kristiansen Date: Wed, 8 May 2019 22:23:49 -0500 Subject: [PATCH] add make fmt to contributing guide --- docs/devguide/contributing.asciidoc | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/devguide/contributing.asciidoc b/docs/devguide/contributing.asciidoc index 21ca1af6e24..db6f28a1b20 100644 --- a/docs/devguide/contributing.asciidoc +++ b/docs/devguide/contributing.asciidoc @@ -83,21 +83,28 @@ recommend that you install it. === Update scripts The Beats use a variety of scripts based on Python to generate configuration files -and documentation. The command used for this is: +and documentation. The primary command used for this is: [source,shell] -------------------------------------------------------------------------------- make update -------------------------------------------------------------------------------- -This command has the following dependencies: +Another command properly formats go source files and adds a copyright header: + +[source,shell] +-------------------------------------------------------------------------------- +make fmt +-------------------------------------------------------------------------------- + +These commands have the following dependencies: * Python >= {python} * https://virtualenv.pypa.io/en/latest/[virtualenv] for Python Virtualenv can be installed with the command `easy_install virtualenv` or `pip install virtualenv`. More details can be found -https://virtualenv.pypa.io/en/latest/installation.html[here]. +https://virtualenv.pypa.io/en/latest/installation.html[here]. Both of these commands should be run before submitting a PR. [float] [[running-testsuite]]