From 44dced9472bc3a9faa8d872279195bfbbe60f4be Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Thu, 16 May 2024 14:37:44 -0400 Subject: [PATCH 1/2] ROADMAP: init --- ROADMAP.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 ROADMAP.md diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000000..6da6ae4a17 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,57 @@ +# SpiceDB Roadmap + +This document provides direction for the contribution and discovery of functionality being built for SpiceDB. + +Because SpiceDB is a community project and has contributions beyond the core maintainers, this document does not attempt to dictate features an ordained timeline. +Instead, this document outlines the project's development philosophy and gives readers the tools to discover on-going community efforts. + +## Proposal Process + +The development of SpiceDB follows a philosophy of identifying problems, proposing solutions, and reaching agreement across relevant stakeholders BEFORE any code is written. + +The complexity of the problem and proposal drive just how much planning work is done. +Proposals loosely follow an [RFC-style] process where anyone in the community is free to represent their opinions and use cases. + +If you have any questions about this process, feel free [ask in our our Discord][discord]. + +[RFC-style]: https://en.wikipedia.org/wiki/Request_for_Comments +[discord]: https://discord.gg/spicedb + +### Functionality not represented by proposals + +Not all contributions require in-depth proposals, but they do require consensus and an opportunity for opinions to be raised before development begins. +The rest of this document does not track the development of this type of functionality, but only the larger initiatives. +You can find this functionality being discussed and developed in less structured GitHub issues that are not labeled as proposal. + +You can find a running list of non-proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aopen+is%3Aissue+-label%3Akind%2Fproposal). + +### Open Proposals + +Proposals can be opened by anyone at any time. + +Although there is no required format, a good proposal contains: + +- Problem statement including use cases +- One or more proposed solutions +- Open problems with the solution +- Links to any related proposals or issues + +You can find a running list of open proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aopen+label%3A%22state%2Fneeds+discussion%22%2C%22state%2Fgauging+interest%22). + +### Accepted Proposals + +Accepted proposals have reached consensus and are ready to have someone begin implementation. + +You can find a running list of accepted proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fproposal+label%3A%22state%2Fimplementation+ready%22). + +### Completed Proposals + +Completed proposals have been implemented in the past. + +You can find a running list of completed proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aissue+label%3Akind%2Fproposal+reason%3Acompleted). + +### Rejected Proposals + +Rejected proposals have not reached consensus or have reached consensus not to be implemented. + +You can find a running list of rejected proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aissue+label%3A%22state%2Fwon%27t+fix%22+label%3Akind%2Fproposal). From f7fcdbce64379962e552a7d9fc3f60689592d4ac Mon Sep 17 00:00:00 2001 From: Jess <140121672+jess-desu@users.noreply.github.com> Date: Thu, 16 May 2024 16:27:37 -0400 Subject: [PATCH 2/2] Update ROADMAP.md added some colored circles for visual cues help with skimming the list quickly --- ROADMAP.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ROADMAP.md b/ROADMAP.md index 6da6ae4a17..c0b1fd5bb9 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -17,7 +17,7 @@ If you have any questions about this process, feel free [ask in our our Discord] [RFC-style]: https://en.wikipedia.org/wiki/Request_for_Comments [discord]: https://discord.gg/spicedb -### Functionality not represented by proposals +### 🟣 Functionality not represented by proposals Not all contributions require in-depth proposals, but they do require consensus and an opportunity for opinions to be raised before development begins. The rest of this document does not track the development of this type of functionality, but only the larger initiatives. @@ -25,7 +25,7 @@ You can find this functionality being discussed and developed in less structured You can find a running list of non-proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aopen+is%3Aissue+-label%3Akind%2Fproposal). -### Open Proposals +### ⚪ Open Proposals Proposals can be opened by anyone at any time. @@ -38,19 +38,19 @@ Although there is no required format, a good proposal contains: You can find a running list of open proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aopen+label%3A%22state%2Fneeds+discussion%22%2C%22state%2Fgauging+interest%22). -### Accepted Proposals +### 🔵 Accepted Proposals Accepted proposals have reached consensus and are ready to have someone begin implementation. You can find a running list of accepted proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fproposal+label%3A%22state%2Fimplementation+ready%22). -### Completed Proposals +### 🟢 Completed Proposals Completed proposals have been implemented in the past. You can find a running list of completed proposals [here](https://github.com/authzed/spicedb/issues?q=is%3Aissue+label%3Akind%2Fproposal+reason%3Acompleted). -### Rejected Proposals +### 🔴 Rejected Proposals Rejected proposals have not reached consensus or have reached consensus not to be implemented.