diff --git a/README.md b/README.md new file mode 100644 index 0000000..946557e --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Roadmap + +[![CNCF](https://img.shields.io/badge/CNCF-Sandbox-blue?logo=cncf)](https://www.cncf.io/projects/tinkerbell/) + +The official Tinkerbell roadmap that provides visibility into high level themes of work and features. + +Anyone can raise a roadmap item for consideration. Raise an issue against this repository and it +will be considered by project maintainers. Ensure you include sufficient detail making minmal +assumptions about the readers knowledge. After some discussion you may be asked to provide a +design; maintainers will guide you as needed. + +When the issue is processed it will appear in the [roadmap project](https://github.com/orgs/tinkerbell/projects/16?query=is%3Aopen+sort%3Aupdated-desc). + +## What is appropriate for the roadmap? + +The roadmap exists for tracking and visibility purposes. Our process is designed to be light weight +without sacraficing necessary detail to gain an high level understanding of project work. + +Items appropriate for the roadmap include anything that presents a significant change - +often but not always across multiple Tinkerbell repositories - or that the community really ought +to be aware of when gaining a snapshot understanding of in-flight work. There are no hard rules +about roadmap item size so if in doubt raise the issue and we can determine how best to track the +work item later. \ No newline at end of file