CONTRIBUTING.md 1.18 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
# Contributing to the Amazon SSM Agent

Contributions to the Amazon SSM Agent should be made via GitHub [pull
requests](https://github.com/aws/amazon-ssm-agent/pulls) and discussed using
GitHub [issues](https://github.com/aws/amazon-ssm-agent/issues).

### Before you start

If you would like to make a significant change, it's a good idea to first open
an issue to discuss it.

### Making the request

14
Development takes place against the `mainline` branch of this repository and pull
15
16
17
18
19
20
21
requests should be opened against that branch.

### Testing

Any contributions should pass all tests, including those not run by our
current CI system.

22
To execute all the tests simply run with `make quick-test`.
23
24
25
26
27
28

Alternatively you can run specific tests by specifying a package, sample below
`go test -v -gcflags "-N -l" github.com/aws/amazon-ssm-agent/agent/fileutil/...`

To execute all the integration tests simply run with `make quick-integtest`.

29
Alternatively you can run specific integration tests by specifying a package, sample below
30
31
32
33
`go test -v -gcflags "-N -l" -tags=integration github.com/aws/amazon-ssm-agent/agent/fileutil/...`

### Licensing

34
The Amazon SSM Agent is licensed under the Apache 2.0 License.