Add ARCHITECTURE.md file #942
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
There was a problem hiding this comment.
Thank you for doing this! I'm trying to think through how exactly to do this but we probably want to further tease apart the auto-genned resource commands (and how they work) with non-API commands (like listen, status, etc).
Probably also worth explaining how configs and plugins work, but that's for us and not you/this PR.
|
Ok, I've tweaked the language based on feedback- it's hopefully more clear now! |
|
updated per your comments- thank you! |
vcheung-stripe
approved these changes
Oct 31, 2022
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.
Reviewers
r?
cc @stripe/developer-products
Summary
After reading through the code, add an ARCHITECTURE file, outlining the general structure of the codebase and hottest code paths. This was mostly meant as an exercise for myself, but I've found it helpful to save and maintain these documents over time.
Also, I haven't done much work in this codebase, so please double check that what I wrote is accurate and helpful! Also, feel free to suggest other important sections that a new contributor would find helpful when diving into an unfamiliar codebase.