diff --git a/0000-template.md b/0000-template.md new file mode 100644 --- /dev/null +++ b/0000-template.md @@ -0,0 +1,27 @@ +# Summary + +One paragraph explanation of the feature. + +# Motivation + +Why are we doing this? What problem does it solve? + +# Explanation + +Explain the design. Include enough detail that someone could implement it. + +# Drawbacks + +Why should we *not* do this? + +# Alternatives + +What other designs were considered? + +# Future Work + +What future work does this change unlock? + +# Unresolved questions + +What needs to be figured out during discussion? diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Star Haven RFCs + +The "RFC" (request for comments) process provides a way to propose and discuss +substantial changes to Star Haven repos before implementing them. Think of it +as collaborative planning. + +## When you need an RFC + +Some changes are "substantial", and we ask that these be put through a bit of +a design process first. This includes: + +- Major architectural decisions (new services, new databases, etc.) +- New features that affect multiple components / are cross-repo + +Many changes, including bug fixes, documentation improvements, and minor UI +tweaks, can be implemented and reviewed via the normal pull request workflow +without an RFC. + +## Process + +- [Fork this repository.](https://tangled.org/starhaven.dev/rfcs/fork) +- Clone your fork locally. +- Copy `0000-template.md` to `text/0000-my-feature.md`. +- Fill in the RFC file. +- Commit on a branch and push it. +- [Submit a pull request.](https://tangled.org/starhaven.dev/rfcs/pulls/new). +- Post it in [Discord](https://starhaven.dev/discord) so we can discuss it. +- Once the open questions have been discussed and solved, edit the RFC file and push. +- The PR will be merged once it the RFC is accepted.