-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs(adr): setting up adr, start to write 00001-plugin #3249
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+180
−0
Conversation
This file contains hidden or 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
6dd4a98
to
9c3a6ad
Compare
9c3a6ad
to
0b3ca84
Compare
@kdy1 please feel free to add commits or modify for the blank part of plugin docs. |
13 tasks
Thank you! I have been wondering what the deciding factors were between |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description:
One of the biggest challenge I had to deal with large codebase was finding out historical context for some behavior, in short
why we do this from beginning
? And sometimes, I made changes without knowing those context then find out changed attempt was already tried and not chosen for various reasons.For those reason I came to believe maintaining some decision records, history even if it's some short form of text can be meaningful. Among those I am in favor of https://adr.github.io/ and would like to propose we'd do the similar thing.
As a first step, this PR attempts to create initial template - mostly blind copy-paste from https://github.com/mozilla/uniffi-rs/tree/main/docs/adr and trying to fill some gaps for the plugin features we are changing now. I don't have full context for all the stories of plugin as well, so I may ask @kdy1 to fill some gaps especially prior decisions we made & why we don't do it.
Related issue (if exists):