Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[metricbeat] add make fmt to contributing guide #12118

Merged
merged 1 commit into from
May 9, 2019
Merged

[metricbeat] add make fmt to contributing guide #12118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/devguide/contributing.asciidoc
View file
Open in desktop
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