ilyagr.bsky.social
just playing with tangled
1# Title
2
3> A cool name for your Project
4
5Author: [Your-Name](mailto:your-name@reachable.com)
6
7> If there are multiple authors, just list them all
8
9## Summary
10
11A short summary of your project/re-design/component and what problems it
12addresses in about 3-10 sentences.
13
14## State of the Feature as of `$VERSION` (optional)
15
16The state of the feature you want to improve and where it currently falls
17short. If there's nothing to compare to, leave it out.
18
19## Prior work (optional)
20
21Does this feature exist somewhere else and which tradeoffs it made.
22
23> If there's no prior work, then use the related work section below.
24
25## Goals and non-goals
26
27Direct goals of the project and features deemed not worth pursuing.
28
29## Overview
30
31A detailed overview of the project and the improvements it brings.
32
33### Detailed Design
34
35The place to describe all new interfaces and interactions and how it plays into
36the existing code and behavior. This is the place for all nitty-gritty details
37which interact with the system.
38
39## Alternatives considered (optional)
40
41Other alternatives to your suggested approach, and why they fall short.
42
43## Issues addressed (optional)
44
45A list of issues which are addressed by this design.
46
47## Related Work (optional)
48
49If there's a feature in another VCS which shares some similarities to your
50proposed work, it belongs here. An example would be Jujutsu sparse workspaces
51and Perforce client workspaces.
52
53## Future Possibilities
54
55The section for things which could be added to it or deemed out of scope during
56the discussion.