Skip to content

Add AGENTS.md guidance for hack/ directory script conventions and review expectations #3508

Description

@fullsend-ai-retro

What happened

On PR #3430, the fullsend review agent raised 4–5 low-severity findings across 8–10 review rounds that the author repeatedly rejected as inappropriate for developer utility scripts in hack/. Specifically: Bash <4.4 compatibility (raised 8 rounds, author: "Bash 4.4 was released in September 2016. Not gonna support decade old bash"), regex dot escaping in sed patterns (10 rounds, author: "Very much a non-issue"), overly broad git add -A staging (9 rounds, author: "we choose this explicitly"), and hardcoded branch lists (9 rounds, author: "Not gonna fix that here"). The PR took 28 days to merge, with the author moving to draft on Jul 31 specifically to work through agent comments. By the final rounds the author's patience was depleted: "right now I just want to merge the PR. We've spent way too long with the nitpicks here."

What could go better

The review agent applied production-code robustness standards uniformly because AGENTS.md contains no guidance about the hack/ directory or its scripts' intended audience and requirements. The agent has no repo-specific signal to distinguish attended developer utilities from production code. While agent-layer improvements to honor author dismissals are tracked separately (fullsend-ai/fullsend#5265, fullsend-ai/agents#106), the repo can independently provide the context signal that would let the agent calibrate severity from the first review — without waiting for agent-layer fixes. Existing AGENTS.md issues #3502 and #3503 cover UBI bump workflow documentation specifically, but do not address the broader hack/ directory conventions.

Proposed change

Add a section to AGENTS.md documenting hack/ directory conventions. Specifically: (1) Scripts in hack/ are attended developer utilities intended for the development team, not production runtime code. (2) Target environment is RHEL 8+ / Fedora, which guarantees Bash 4.4+; backward compatibility with older Bash is explicitly not required. (3) These scripts accept minor theoretical risks appropriate for attended usage — e.g., unescaped dots in sed patterns operating on controlled inputs, hardcoded branch lists that change infrequently. (4) Reviewer guidance: robustness and portability findings below Medium severity should be suppressed for hack/ scripts unless they affect correctness in the target environment. Focus review on logic errors, data loss risks, and git safety issues.

Validation criteria

On the next 3 PRs that modify files in hack/, the review agent should not raise Bash <4.4 compatibility findings or regex dot-escaping findings. Review comments on hack/ scripts should focus on correctness and safety issues rather than robustness/portability concerns that the AGENTS.md explicitly accepts.


Generated by retro agent from #3430

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions