From 27c3a6557f00d05c4e1cafa73038635de51074e6 Mon Sep 17 00:00:00 2001 From: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:30:34 -0500 Subject: [PATCH] Add guidelines for making new capability proposals (#207) As discussed with OpAMP approvers/maintainers this adds the requirement to have working prototypes for specification proposals. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 5e084fe..d85ba43 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,27 @@ 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 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 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 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) +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 + Approvers ([@open-telemetry/opamp-spec-approvers](https://github.com/orgs/open-telemetry/teams/opamp-spec-approvers)): - [Andy Keller](https://github.com/andykellr), observIQ