docs: Formalize our design docs process a bit. #3940
Merged
Conversation
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
PhilipMetzger
force-pushed
the
push-kzzmwxztmyrv
branch
from
63c31d7 to
9f31439
Compare
fowles
approved these changes
Jun 28, 2024
matts1
reviewed
Jun 28, 2024
matts1
approved these changes
Jun 28, 2024
PhilipMetzger
force-pushed
the
push-kzzmwxztmyrv
branch
2 times, most recently
from
4f72113 to
09041cf
Compare
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.
This should be the template for all new Design Docs, minor deviations aside. Hopefully this makes the process a bit easier.
PhilipMetzger
force-pushed
the
push-kzzmwxztmyrv
branch
from
09041cf to
b1b1e9f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.