From 3af79a8f351cf75ebd448a73fa7bf0adadd288bb Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Wed, 27 Nov 2024 12:30:09 -0500 Subject: [PATCH 1/3] Add guidelines for making new capability proposals As discussed with OpAMP approvers/maintainers this adds the requirement to have working prototypes for specification proposals. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 5e084fe..5770498 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,25 @@ If any changes are made to Protobuf message definitions in the specification.md sure to update also the `*.proto` files in the [proto](proto) directory. Run `make gen-proto` to run the Protobuf compiler and verify the `*.proto` files. +## Proposal Requirements + +Proposals to add new capabilities to OpAMP specification must be accompanied by working +prototypes in [opamp-go](https://github.com/open-telemetry/opamp-go), demonstrating +the capability. The prototype can be a PR against opamp-go or can be on your own fork +of opamp-go. + +To make a proposal create a PR in this repo that modifies the specification markdown +and the Protobuf files and include a link to the prototype in the description. We +advise to attend the OpAMP SIG meeting and discuss your proposal before you spend +effort on it to make sure the proposal is aligned with SIG's vision. + +All new capabilities must be added in +[Development](https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/0232-maturity-of-otel.md#development) +maturity level initially. Make sure to add `[Development]` status label in the +specification markdown and as a prefix of the added proto field or message. + +## Contributors + Approvers ([@open-telemetry/opamp-spec-approvers](https://github.com/orgs/open-telemetry/teams/opamp-spec-approvers)): - [Andy Keller](https://github.com/andykellr), observIQ From 70264f282a2d1736a0675ffe78c50cb288383318 Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Wed, 27 Nov 2024 13:30:57 -0500 Subject: [PATCH 2/3] Fixes based on comments --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5770498..d5c2ae9 100644 --- a/README.md +++ b/README.md @@ -20,19 +20,21 @@ to run the Protobuf compiler and verify the `*.proto` files. ## Proposal Requirements -Proposals to add new capabilities to OpAMP specification must be accompanied by working -prototypes in [opamp-go](https://github.com/open-telemetry/opamp-go), demonstrating -the capability. The prototype can be a PR against opamp-go or can be on your own fork -of opamp-go. - -To make a proposal create a PR in this repo that modifies the specification markdown +Proposals to add new capabilities to the OpAMP specification must be accompanied by +working prototypes in [opamp-go](https://github.com/open-telemetry/opamp-go), +demonstrating the capability. The prototype can be a PR against opamp-go or can be on +your own fork of opamp-go. The prototype will be used to help aid maintainers in +understanding the implications of the specification changes and how actual usage might +look. + +To make a proposal, create a PR in this repo that modifies the specification markdown and the Protobuf files and include a link to the prototype in the description. We -advise to attend the OpAMP SIG meeting and discuss your proposal before you spend +advise you to attend the OpAMP SIG meeting and discuss your proposal before you spend effort on it to make sure the proposal is aligned with SIG's vision. All new capabilities must be added in [Development](https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/0232-maturity-of-otel.md#development) -maturity level initially. Make sure to add `[Development]` status label in the +maturity level initially. Make sure to add the `[Development]` status label in the specification markdown and as a prefix of the added proto field or message. ## Contributors From d738b4bc1b7ddd057d6f193d4d9323ee2e163067 Mon Sep 17 00:00:00 2001 From: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:08:48 -0500 Subject: [PATCH 3/3] Update README.md Co-authored-by: Andy Keller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d5c2ae9..d85ba43 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ look. To make a proposal, create a PR in this repo that modifies the specification markdown and the Protobuf files and include a link to the prototype in the description. We advise you to attend the OpAMP SIG meeting and discuss your proposal before you spend -effort on it to make sure the proposal is aligned with SIG's vision. +effort on it to make sure the proposal is aligned with the SIG's vision. All new capabilities must be added in [Development](https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/0232-maturity-of-otel.md#development)