mirror of
https://github.com/jj-vcs/jj.git
synced 2026-07-03 14:02:54 +08:00
3a0dae3df6
The project at this point has had multiple people show up with Design docs where it was clear that they neither understood the concept of them or just wanted to discuss some idea which clearly belongs into a downstream project. A part of this also discourages them to people which have no experience on the project yet. I personally also would like to discourage genAI usage for writing them, but that seems problematic since the project isn't really clear on their usage, since the goal of them is clearly not to produce 10'000 words but an actual understanding of the problem and approaches to solve it.
1.1 KiB
1.1 KiB
Jujutsu Design Docs
Jujutsu uses Design Docs to drive technical decisions on large projects and it is the place to discuss your proposed design or new component. It is a very thorough process, in which the design doc must be approved before PRs for the feature will be accepted. It shares some similarities with Rust RFCs but mostly addresses technical problems and gauges the technical and social concerns of all stakeholders.
So if you want to start building a native backend or the server component for Jujutsu, you'll need to go through this process.
Process
- Add a new markdown document to
docs/design, named after your improvement or project. - Describe the current state of the world and the things you want to improve.
- Wait for the Maintainers and Stakeholders to show up.
- Iterate until everyone accepts the change in normal codereview fashion.
Blueprint (Template)
You can find the base template of a new Design Doc here.