Skip to content

Commit

Permalink
[docs] add make fmt to contributing guide (#12118)
Browse files Browse the repository at this point in the history
  • Loading branch information
fearful-symmetry committed May 9, 2019
1 parent 44a87a8 commit 0460448
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/devguide/contributing.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down

0 comments on commit 0460448

Please sign in to comment.