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