docs: Add RATIONALE.md - #200
Merged
philipaconrad merged 1 commit intoSep 22, 2026
Merged
Conversation
This commit adds a "rationale" file to our project to track design and implementation decisions over time. This can be helpful for understanding historical context around an API design, and may hep future contributors identify places where an earlier decision's assumptions no longer hold. The file currently explains our external dependencies strategy, as well as the background behind the `tools/SyncGen` macro. Signed-off-by: Philip Conrad <philip_conrad@apple.com>
srenatus
reviewed
Sep 23, 2026
| For an infrequently-used development tool, we feel this is a reasonable hassle for *us* to deal with, but unreasonable for downstream users to have to grapple with. | ||
|
|
||
|
|
||
| ## API Design |
Contributor
There was a problem hiding this comment.
Looks like the printer ate the rest of it 😉
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
3 participants
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.
What code changed, and why?
This PR adds a "rationale" file to our project to track design and implementation decisions over time. This can be helpful for understanding historical context around an API design, and may hep future contributors identify places where an earlier decision's assumptions no longer hold.
The file currently explains our external dependencies strategy, as well as the background behind the
tools/SyncGenmacro.Related Resources