Skip to content

Commit c9d2d8e

Browse files
committed
addressed PR comemnts
1 parent 5a8da56 commit c9d2d8e

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
# Important note
44

5-
This repository contains the source code for the Datadog Agent until major version 5.
5+
This repository contains the source code for the Datadog Agent up to and including
6+
major version 5.
67
Although still supported, no major feature is planned for this release line and we
78
encourage users and contributors to refer to the new Agent codebase, introduced
89
with the release of version 6.0.0 and tracked in
@@ -13,6 +14,45 @@ with the release of version 6.0.0 and tracked in
1314
Please refer to the [Change log](https://github.com/DataDog/dd-agent/blob/master/CHANGELOG.md)
1415
for more details about the changes introduced at each release.
1516

17+
## How to contribute code
18+
19+
Before submitting any code, please read our [contributing guidelines](CONTRIBUTING.md).
20+
We'll keep accepting contributions as long as the major version 5 is supported
21+
but please consider submitting new features to the new Agent codebase.
22+
23+
Please note that the Agent is licensed for simplicity's sake
24+
under a simplified BSD license, as indicated in the `LICENSE` file.
25+
Exceptions are marked with LICENSE-xxx where xxx is the component name.
26+
If you do **not** agree with the licensing terms and wish to contribute code nonetheless,
27+
please email us at <[email protected]> before submitting your
28+
pull request.
29+
30+
### Setup your environment
31+
32+
Required:
33+
34+
* python 2.7
35+
* bundler (to get it: `gem install bundler`)
36+
37+
```
38+
# Clone the repository
39+
git clone [email protected]:DataDog/dd-agent.git
40+
41+
# Create a virtual environment and install the dependencies:
42+
cd dd-agent
43+
bundle install
44+
rake setup_env
45+
46+
# Activate the virtual environment
47+
source venv/bin/activate
48+
49+
# Lint
50+
bundle exec rake lint
51+
52+
# Run a flavored test
53+
bundle exec rake ci:run[apache]
54+
```
55+
1656
## Integrations
1757

1858
All checks have been moved to the [Integrations Core](https://github.com/DataDog/integrations-core) repo.

0 commit comments

Comments
 (0)