CodeForPhilly / CodeForPhilly/codeforphilly-ng

import-laddr: --limit semantics need a --help doc

未关闭
#26 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
1
派生
1
平均合并
5 天 3 小时
30 天内合并 PR
9

描述

\`--limit=N\` truncates per-table to N *imported* rows, but the report still counts pre-limit rows under \`input\`, so \`imported + skipped + errors < input\` when the flag is in play. This is intentional — dry-run reports should reflect the dump's actual size — but may surprise staff scanning a report.

Once we settle on a CLI help framework (in apps/api/scripts/), document:
- \`--limit\` precisely (per-table cap on imported rows; input still counts dump size)
- All the other flags
- The 7-commit pattern + idempotence semantics

Filed as Follow-up from PR #24 (laddr-import).

贡献指南

这个仓库没有索引到贡献指南

调研方向

从 apps/api/scripts/ 开始,查看 PR #24,了解 laddr-import 入口点、现有 flags,以及 7-commit 和幂等性的语义。CLI 帮助框架确定后,记录 --limit 和其余 flags;当帮助文本能够准确说明报告计数和导入行为时,即可视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
cli, documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。