-
Notifications
You must be signed in to change notification settings - Fork 348
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Formalize our design docs process a bit.
This adds the basic outline of _when_ a Design Doc should be written. See the next commit in the stack for the blueprint. By adding this we hopefully can prevent unnecessary churn from new and longtime contributors, when they want to add a major feature or rewrite a core part of Jujutsu. The text is written as a guideline, not a rule.
- Loading branch information
1 parent
5abc87f
commit 0ea2d4d
Showing
3 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# 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 all concerns must be addressed. 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 the native backend or the server component for | ||
Jujutsu, you'll need to go through this process. It also is good if you're | ||
already familiar with the codebase, to not stall the implementation. | ||
|
||
## Process | ||
|
||
1. Add a new markdown document to `docs/design`, named after your improvement | ||
or project. | ||
1. Describe the current state of the world and the things you want to improve. | ||
1. Wait for the Maintainers and Stakeholders to show up. | ||
1. Iterate until everyone accepts the change in normal codereview fashion. | ||
|
||
|
||
[Rust RFCs]: https://github.com/rust-lang/rfcs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters