diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 346080e5..1fa318b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,22 @@ To build the project, run: ./gradlew assemble ``` +## Generating semantic conventions + +Requires docker. + +In a shell, execute the following gradle tasks: + +```shell +./gradlew clean generateSemanticConventions --console=plain +./gradlew spotlessApply +``` + +This will download the version +of [open-telemetry/semantic-conventions](https://github.com/open-telemetry/semantic-conventions) +defined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and +generate semantic conventions classes from the release contents. + ## Style guide This repository follows the OpenTelemetry Java diff --git a/README.md b/README.md index 8469c742..11c3c84f 100644 --- a/README.md +++ b/README.md @@ -73,31 +73,9 @@ Stable artifacts (i.e. artifacts without `-alpha` version suffix) come with stro Compatibility guarantees are inherited from [opentelemetry-java][versioning]. -## Generating semantic conventions - -Requires docker. - -In a shell, execute the following gradle tasks: - -```shell -./gradlew clean generateSemanticConventions --console=plain -./gradlew spotlessApply -``` - -This will download the version -of [open-telemetry/semantic-conventions](https://github.com/open-telemetry/semantic-conventions) -defined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and -generate semantic conventions classes from the release contents. - ## Contributing -Before you start - see OpenTelemetry -general [contributing](https://github.com/open-telemetry/community/tree/main/guides/contributor) -requirements and recommendations. - -Make sure to review the projects [license](LICENSE) and sign -the [CNCF CLA](https://identity.linuxfoundation.org/projects/cncf). A signed CLA will be enforced by -an automatic check once you submit a PR, but you can also sign it after opening your PR. +See [CONTRIBUTING.md](CONTRIBUTING.md). ### Maintainers diff --git a/RELEASING.md b/RELEASING.md index 5127f8b3..eb873017 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -13,7 +13,7 @@ Applies to major, minor and patch releases of `open-telemetry/semantic-conventio * Bump the `semanticConventionsVersion` variable in `build.gradle.kts` to version of `semantic-conventions` to be released * Follow the instructions - to [generate the semantic conventions](README.md#generating-semantic-conventions) + to [generate the semantic conventions](CONTRIBUTING.md#generating-semantic-conventions) * Run the [Prepare release branch workflow](https://github.com/open-telemetry/semantic-conventions-java/actions/workflows/prepare-release-branch.yml) * Press the "Run workflow" button, and leave the default branch `main` selected