Skip to content

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
merged 19 commits into from
Jan 13, 2022

Conversation

kwonoj
Copy link
Member

@kwonoj kwonoj commented Jan 13, 2022

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):

@kwonoj
Copy link
Member Author

kwonoj commented Jan 13, 2022

@kdy1 please feel free to add commits or modify for the blank part of plugin docs.

@kdy1 kdy1 merged commit 8652b2d into swc-project:main Jan 13, 2022
@kwonoj kwonoj deleted the init-adr-plugin branch January 15, 2022 06:34
@martindisch
Copy link

Thank you! I have been wondering what the deciding factors were between wasmtime and wasmer, so this ADR was perfect.

@swc-project swc-project locked as resolved and limited conversation to collaborators Oct 28, 2022
@kdy1 kdy1 added this to the Unknown milestone Jul 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants