Add the decision records - #81
Merged
Merged
Conversation
Eight records, one per design decision that shapes the code today, each with the situation, what was decided, what it costs and where the code is, so a change that reverses one is made knowingly.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The architecture page says how the code works; nothing said why, and the reasons for the choices that shape it (one thread per context, three callback paths, ETF results, a child process for isolation, a gen_statem for it, iommap for bulk data, the removal of the old paths, the pipe rules) were spread over commit messages, changelog entries and memory. This adds one record per decision, in the order they were taken, with what was considered and not chosen, what each costs, and the file to read. New decisions add a record; old ones are not edited.
Replaces #80, which GitHub closed when its stacked base branch was deleted.