From 88685b0475983c2fc59fa30020b1b0c674d53120 Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Wed, 3 Jan 2018 17:19:19 -0500 Subject: [PATCH] Update roadmap.md with issue labels and milestones Signed-off-by: Michael Crosby --- ROADMAP.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/ROADMAP.md b/ROADMAP.md index 473d41a48..aacd10739 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,3 +1,28 @@ -# containerd Roadmap +# containerd roadmap -Please review the milestones on [github](https://github.com/containerd/containerd/milestones) for the updated roadmap and release information. +containerd uses the issues and milestones to define its roadmap. +`ROADMAP.md` files are common in open source projects but we find they quickly become out of date. +We opt for an issues and milestone approach that our maintainers and community can keep up-to-date as work is added and completed. + +## Issues + +Issues tagged with the `roadmap` label are high level roadmap items. +They are tasks and/or features that the containerd community wants completed. + +Smaller issues and pull requests can reference back to the main roadmap issue that is tagged to help detail progress towards the overall goal. + +## Milestones + +Milestones define when an issue, pull request, and/or roadmap item is to be completed. +Issues are the what, milestones are the when. +Development is complex therefore roadmap items can move between milestones depending on the remaining development and testing required to release a change. + +## Searching + +To find the roadmap items currently planned for containerd you can filter on the `roadmap` label. + +[Search Roadmap Items](https://github.com/containerd/containerd/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap) + +After searching for roadmap items you can view what milestone they are scheduled to be completed in along with the progress. + +[View Milestones](https://github.com/containerd/containerd/milestones)