Skip to content

Commit a42426d

Browse files
authored
Create RFC template (#3193)
* Create RFC template * include process doc * feedback * spacing * enumerate status
1 parent 3b1eac2 commit a42426d

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

docs/rfcs/README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# RFC Process
2+
3+
The RFC process for the OpenTelemetry Operator exists so that community members can effectively review and understand
4+
major decisions made by the Operator SIG. The RFC process also allows users to comment asynchronously on design
5+
decisions.
6+
7+
We aim to improve the experience for using OpenTelemetry tools in a Kubernetes
8+
environment. Proposals here should only focus on improving that experience by composing existing
9+
OpenTelemetry components such as the OpenTelemetry Collector, OpenTelemetry Instrumentation, OpAMP, etc.
10+
If a proposal requires new components to exist that do not logically fit within that mission, it's recommended to
11+
open proposals with the proper SIGs.
12+
13+
## Process
14+
15+
1. Copy and fill the [template.md](./template.md) document
16+
2. Open a PR to get initial feedback on RFC
17+
3. The RFC must be discussed at the Operator SIG Meeting at least once prior to merge
18+
4. Upon merge, the RFC's status will still be Draft. At this point, the RFC has been accepted and an implementation
19+
can be started
20+
1. The initial implementation's PR should change the status to accepted
21+
2. If any significant changes are made that deviate from the RFC, the RFC should be updated to reflect that
22+
23+
## Recommendations
24+
25+
During the RFC process, the [template.md](./template.md) must be filled out. We recommend also doing the following:
26+
27+
* Include a proof-of-concept to confirm the design
28+
* Share alternatives considered and tradeoffs
29+
* A valid alternative to consider is always "do nothing"
30+
* Pair with a SIG member to sort through unknowns / ask for help

docs/rfcs/template.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# TITLE
2+
3+
**Status:** [*Draft* | *Accepted*]
4+
5+
**Author:** <your-name>
6+
7+
**Date:** <todays-date>
8+
9+
10+
## Objective
11+
12+
[comment]: # (Describe the objective for this proposal)
13+
14+
## Summary
15+
16+
[comment]: # (Summarize the design for the proposal)
17+
18+
## Goals and non-goals
19+
20+
[comment]: # (Describe the objective for this proposal)
21+
22+
## Use cases for proposal
23+
24+
### CASE 1
25+
26+
[comment]: # (Describe case #1)
27+
28+
### CASE 2
29+
30+
[comment]: # (Describe case #2)
31+
32+
### CASE N
33+
34+
[comment]: # (Describe case #N)
35+
36+
## Struct Design
37+
38+
[comment]: # (Describe the go struct that will be introduced for this change, if applicable)
39+
40+
## Rollout Plan
41+
42+
[comment]: # (Describe how the change will be rolled out in the operator repo and for users)
43+
44+
## Limitations
45+
46+
[comment]: # (Describe the limitations and design decisions made here)

0 commit comments

Comments
 (0)