Skip to content

Commit 02a5ea4

Browse files
authored
Update CONTRIBUTING.md (#284)
* Update CONTRIBUTING.md * Fix link
1 parent 907e87e commit 02a5ea4

File tree

3 files changed

+18
-24
lines changed

3 files changed

+18
-24
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,22 @@ To build the project, run:
1818
./gradlew assemble
1919
```
2020

21+
## Generating semantic conventions
22+
23+
Requires docker.
24+
25+
In a shell, execute the following gradle tasks:
26+
27+
```shell
28+
./gradlew clean generateSemanticConventions --console=plain
29+
./gradlew spotlessApply
30+
```
31+
32+
This will download the version
33+
of [open-telemetry/semantic-conventions](https://github.com/open-telemetry/semantic-conventions)
34+
defined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and
35+
generate semantic conventions classes from the release contents.
36+
2137
## Style guide
2238

2339
This repository follows the OpenTelemetry Java

README.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -73,31 +73,9 @@ Stable artifacts (i.e. artifacts without `-alpha` version suffix) come with stro
7373

7474
Compatibility guarantees are inherited from [opentelemetry-java][versioning].
7575

76-
## Generating semantic conventions
77-
78-
Requires docker.
79-
80-
In a shell, execute the following gradle tasks:
81-
82-
```shell
83-
./gradlew clean generateSemanticConventions --console=plain
84-
./gradlew spotlessApply
85-
```
86-
87-
This will download the version
88-
of [open-telemetry/semantic-conventions](https://github.com/open-telemetry/semantic-conventions)
89-
defined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and
90-
generate semantic conventions classes from the release contents.
91-
9276
## Contributing
9377

94-
Before you start - see OpenTelemetry
95-
general [contributing](https://github.com/open-telemetry/community/tree/main/guides/contributor)
96-
requirements and recommendations.
97-
98-
Make sure to review the projects [license](LICENSE) and sign
99-
the [CNCF CLA](https://identity.linuxfoundation.org/projects/cncf). A signed CLA will be enforced by
100-
an automatic check once you submit a PR, but you can also sign it after opening your PR.
78+
See [CONTRIBUTING.md](CONTRIBUTING.md).
10179

10280
### Maintainers
10381

RELEASING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Applies to major, minor and patch releases of `open-telemetry/semantic-conventio
1313
* Bump the `semanticConventionsVersion` variable in `build.gradle.kts` to version
1414
of `semantic-conventions` to be released
1515
* Follow the instructions
16-
to [generate the semantic conventions](README.md#generating-semantic-conventions)
16+
to [generate the semantic conventions](CONTRIBUTING.md#generating-semantic-conventions)
1717
* Run
1818
the [Prepare release branch workflow](https://github.com/open-telemetry/semantic-conventions-java/actions/workflows/prepare-release-branch.yml)
1919
* Press the "Run workflow" button, and leave the default branch `main` selected

0 commit comments

Comments
 (0)