You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[chore][CONTRIBUTING.md] Add test instructions and reorder and improve sections (#40100)
#### Documentation
Add a test section to the contributing guideline, also reorder and
improve other sections.
It aims to put the section in the order a new contributor would need
them.
The actual name of the binary will depend on your platform. For example, on Linux x64, use `./bin/otelcontribcol_linux_amd64`.
26
+
27
+
Replace `otel-config.yaml` with the appropriate configuration file as needed.
28
+
29
+
3. Verify that your changes are reflected in the contrib Collector's behavior by
30
+
testing it against the provided configuration.
31
+
32
+
4. Lint your changes:
33
+
34
+
- For the entire project:
35
+
```shell
36
+
make golint
37
+
```
38
+
39
+
- For specific components (e.g., Elasticsearch exporter):
40
+
```shell
41
+
cd exporter/elasticsearchexporter/
42
+
make lint
43
+
```
44
+
45
+
5. Run the unit tests:
46
+
47
+
- Run tests for the whole project from the project root:
48
+
```shell
49
+
make gotest
50
+
```
51
+
- Alternatively, run tests for the affected components. For example, to run the Elasticsearch exporter tests:
52
+
```shell
53
+
cd exporter/elasticsearchexporter/
54
+
make test
55
+
```
22
56
23
57
## Changelog
24
58
25
59
### Overview
26
60
27
-
There are two Changelogs for this repository:
61
+
There are two auto generated Changelogs for this repository:
28
62
29
63
-`CHANGELOG.md` is intended for users of the collector and lists changes that affect the behavior of the collector.
30
64
-`CHANGELOG-API.md` is intended for developers who are importing packages from the collector codebase.
31
65
66
+
They are autogenerated from `.yaml` files in the `./.chloggen` directory.
67
+
68
+
### Adding a Changelog Entry
69
+
70
+
1. Create an entry file using `make chlog-new`. This generates a file based on your current branch (e.g. `./.chloggen/my-branch.yaml`)
71
+
2. Fill in all fields in the new file
72
+
3. Run `make chlog-validate` to ensure the new file is valid
73
+
4. Commit and push the file
74
+
75
+
During the collector release process, all `./chloggen/*.yaml` files are transcribed into `CHANGELOG.md` and `CHANGELOG-API.md` and then deleted.
76
+
32
77
### When to add a Changelog Entry
33
78
34
79
Pull requests that contain user-facing changes will require a changelog entry. Keep in mind the following types of users:
@@ -37,7 +82,7 @@ Pull requests that contain user-facing changes will require a changelog entry. K
37
82
3. Those who are depending on APIs exported from collector packages
38
83
4. Those who are contributing to the repository
39
84
40
-
Changes that affect the first two groups should be noted in `CHANGELOG.md`. Changes that affect the third or forth groups should be noted in `CHANGELOG-API.md`.
85
+
Changes that affect the first two groups should be noted in `CHANGELOG.md`. Changes that affect the third or fourth groups should be noted in `CHANGELOG-API.md`.
41
86
42
87
If a changelog entry is not required, a maintainer or approver will add the `Skip Changelog` label to the pull request.
43
88
@@ -61,21 +106,59 @@ No changelog entry:
61
106
- Most changes to tests
62
107
- Chores, such as enabling linters, or minor changes to the CI process
63
108
64
-
### Adding a Changelog Entry
109
+
##Pull-requests
65
110
66
-
The [CHANGELOG.md](./CHANGELOG.md) and [CHANGELOG-API.md](./CHANGELOG-API.md) files in this repo is autogenerated from `.yaml` files in the `./.chloggen` directory.
111
+
### Title guidelines
67
112
68
-
Your pull-request should add a new `.yaml` file to this directory. The name of your file must be unique since the last release.
113
+
The title for your pull-request should contain the component type and name in brackets, plus a short statement for your
114
+
change. For instance:
69
115
70
-
During the collector release process, all `./chloggen/*.yaml` files are transcribed into `CHANGELOG.md` and `CHANGELOG-API.md` and then deleted.
116
+
[processor/tailsampling] fix AND policy
71
117
72
-
**Recommended Steps**
73
-
1. Create an entry file using `make chlog-new`. This generates a file based on your current branch (e.g. `./.chloggen/my-branch.yaml`)
74
-
2. Fill in all fields in the new file
75
-
3. Run `make chlog-validate` to ensure the new file is valid
76
-
4. Commit and push the file
118
+
### Description guidelines
119
+
120
+
When linking to an open issue, if your PR is meant to close said issue, please prefix your issue with one of the
121
+
following keywords: `Resolves`, `Fixes`, or `Closes`. More information on this functionality (and more keyword options) can be found
This will automatically close the issue once your PR has been merged.
77
124
78
-
Alternately, copy `./.chloggen/TEMPLATE.yaml`, or just create your file from scratch.
125
+
126
+
## Issue Triaging
127
+
128
+
See [issue-triaging.md](./issue-triaging.md) for more information on the issue triaging process.
129
+
130
+
### Adding Labels via Comments
131
+
132
+
In order to facilitate proper label usage and to empower Code Owners, you are able to add labels to issues via comments. To add a label through a comment, post a new comment on an issue starting with `/label`, followed by a space-separated list of your desired labels. Supported labels come from the table below, or correspond to a component defined in the [CODEOWNERS file](.github/CODEOWNERS).
@@ -264,43 +347,6 @@ in general try to follow them.
264
347
- `replace` statements in `go.mod` files can be automatically inserted by running `make crosslink`. For more information
265
348
on the `crosslink` tool see the README [here](https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/crosslink).
266
349
267
-
## Issue Triaging
268
-
269
-
See [issue-triaging.md](./issue-triaging.md) for more information on the issue triaging process.
270
-
271
-
### Adding Labels via Comments
272
-
273
-
In order to facilitate proper label usage and to empower Code Owners, you are able to add labels to issues via comments. To add a label through a comment, post a new comment on an issue starting with `/label`, followed by a space-separated list of your desired labels. Supported labels come from the table below, or correspond to a component defined in the [CODEOWNERS file](.github/CODEOWNERS).
0 commit comments