Skip to content

Commit

Permalink
Update CONTRIBUTING.md with dependencies (elastic#1605)
Browse files Browse the repository at this point in the history
  • Loading branch information
ruflin authored and tsg committed May 12, 2016
1 parent 28b46d9 commit 0a65050
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,22 @@ Packetbeat:
Some of the Beats might have extra development requirements, in which case a
CONTRIBUTING.md file is find in the Beat directory.

## Update scripts

The beats use a variety of scripts based on python to generate configuration files
and documentations. The command used for this is:

$ make update

This command has the following dependencies:

* Python >=2.7.9
* [virtualenv](https://virtualenv.pypa.io/en/latest/) for Python

Virtualenv can be installed with the command `easy_install virtualenv` or `pip install virtualenv`.
More details can be [here](https://virtualenv.pypa.io/en/latest/installation.html).


## Testing

You can run the whole testsuite with the following command:
Expand All @@ -87,11 +103,6 @@ Running the testsuite has the following requirements:

## Dependencies

The Beats project is using the [Go 1.5 vendor
experiment](https://docs.google.com/document/d/1Bz5-UB7g2uPBdOx-rw5t9MxJwkfpx90cqG9AFL0JAYo/edit)
for its dependencies. This means the Go dependencies code is copied under the
`vendor/` directory and committed into source control.

To manage the `vendor/` folder we use
[glide](https://github.com/Masterminds/glide), which uses
[glide.yaml](glide.yaml) as a manifest file for the dependencies. Please see
Expand Down

0 comments on commit 0a65050

Please sign in to comment.