docs: add async file I/O and auth rate limiting patterns to DEVELOPMENT.md#284
Merged
hoiekim merged 1 commit intohoiekim:mainfrom Mar 26, 2026
Merged
Conversation
Contributor
Author
Self-ReviewDiscussion thread status:
Checked:
Issues found:
Confidence: High |
ff8374d to
cb4b4c6
Compare
hoiekim
approved these changes
Mar 26, 2026
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
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.
Changes
Adds two new patterns to DEVELOPMENT.md:
File I/O in Async Context
Documents the anti-pattern of wrapping
writeFileSyncin Promise constructors (gives false impression of async behavior while still blocking the event loop). Recommendsfs.promisesAPIs andmkdir({ recursive: true })over check-then-create.IMAP/SMTP Authentication Rate Limiting
Documents the need for rate limiting across all auth protocols (HTTP, IMAP, SMTP) with shared counters to prevent protocol-switching brute force attacks.
Context
E2E Testing
Documentation-only change. Verified markdown renders correctly and no code changes.