Skip to content

Commit

Permalink
Add guidelines for making new capability proposals (#207)
Browse files Browse the repository at this point in the history
As discussed with OpAMP approvers/maintainers this
adds the requirement to have working prototypes for
specification proposals.
  • Loading branch information
tigrannajaryan authored Nov 27, 2024
1 parent 75aa498 commit 27c3a65
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 27c3a65

Please sign in to comment.