Skip to content

Commit f520470

Browse files
committed
docs: clarify helper function guidance
1 parent b7f6baa commit f520470

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ AWS_DEFAULT_REGION=us-east-1 pytest --run-integration python/tests/test_s3_ddb.p
6262
- Comments should explain non-obvious "why" reasoning, not restate what the code does.
6363
- Remove debug prints (`println!`, `dbg!`, `print()`) before merging — use `tracing` or logging frameworks.
6464
- Extract logic repeated in 2+ places into a shared helper; inline single-use logic at its call site.
65+
- Think carefully before adding a helper: only introduce one when it materially reduces cognitive load or eliminates substantial duplication, and do not add thin wrappers that only rename or forward existing calls.
6566
- Keep PRs focused — no drive-by refactors, reformatting, or cosmetic changes.
6667
- Be mindful of memory use: avoid collecting streams of `RecordBatch` into memory; use `RoaringBitmap` instead of `HashSet<u32>`.
6768

0 commit comments

Comments
 (0)