https://github.com/tinkerbell/proposals
Proposals & RFCs for the Tinkerbell project
https://github.com/tinkerbell/proposals
Last synced: 5 months ago
JSON representation
Proposals & RFCs for the Tinkerbell project
- Host: GitHub
- URL: https://github.com/tinkerbell/proposals
- Owner: tinkerbell
- License: apache-2.0
- Created: 2020-06-02T14:36:50.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T17:45:47.000Z (over 3 years ago)
- Last Synced: 2025-10-11T19:03:39.191Z (10 months ago)
- Size: 1.82 MB
- Stars: 4
- Watchers: 19
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Proposals
The proposals repository exists to keep contributors and new people to the project up to speed
with project activity. Given our small community of contributors, our proposals process is
deliberately light weight. A light weight process lets us move quickly while still highlighting
key details for the community.
To create a proposal, raise an issue in this repository with pieces from the template below
that are relevant for your proposal.
If you wish to see proposals prior to the change in process you can check out commit
[28ad00608c176871a57d5a5519d9a3f4b9d1cf98](https://github.com/tinkerbell/proposals/commit/28ad00608c176871a57d5a5519d9a3f4b9d1cf98).
---
# Title
## Context
Describe background detail necessary to appreciate the changes you're proposing to help readers
orient.
## Goals/Non-goals
Consider succinctly describing (a few sentences) what you will achieve with this proposal. You
may wish to call out some specific non-goals also.
## Proposal
Start by summarizing your changes at a high level in a way that compliments the context already
laid out.
Then dive in a little deeper using diagramming as necessary to clarify specifics. Typically
boundaries require additional information to help readers understand what contracts look like.
For example, what does the contract between 2 services look like? What technology/protocol will
they use?
## Rationale
Summarise alternatives that were considered and elaborate on why they are unsatisfactory by
comparison. There is significant value in portraying options to readers so they can weigh
up pros and cons. It can be difficul to generate alternatives but that shouldn't be used as a
reason to avoid it so do think carefully before removing this section.