HYPERFLEET-930 - feat: add AGENTS.md and simplify CLAUDE.md#108
HYPERFLEET-930 - feat: add AGENTS.md and simplify CLAUDE.md#108kuudori wants to merge 2 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR consolidates E2E testing guidance by introducing a comprehensive AGENTS.md instruction document that defines test conventions, tooling workflow, naming rules, async patterns, and runtime gotchas. Related changes harmonize development, contributing, and getting-started documentation to enforce the new conventions: test naming with Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Makefile`:
- Around line 107-111: The fmt-check target is masking formatter failures
because the current conditional only inspects pipe output and not the exit
status of "$(GOLANGCI_LINT) fmt --diff ./... | tee /dev/stderr | (! read)"; fix
it by running that pipeline in a bash subshell with pipefail enabled (so the
pipeline's exit status reflects the formatter command) and use that exit status
in the existing if ! ... then branch for fmt-check (reference the Makefile
target fmt-check and the pipeline containing $(GOLANGCI_LINT) fmt --diff ./... |
tee /dev/stderr | (! read) to locate the code).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: f696652d-6f8e-4f32-a0ed-833a3959af9c
📒 Files selected for processing (15)
.golangci.yml.pre-commit-config.yamlAGENTS.mdCLAUDE.mdCONTRIBUTING.mdMakefilecmd/hyperfleet-e2e/common/config.gocmd/hyperfleet-e2e/test/cmd.godocs/architecture.mddocs/development.mddocs/getting-started.mdpkg/client/maestro/discovery.gopkg/helper/adapter.gopkg/helper/k8s.gopkg/helper/k8s_test.go
CLAUDE.md now imports AGENTS.md via @AGENTS.md directive. AGENTS.md contains verified, deduplicated agent instructions with source-of-truth table, test conventions, and project boundaries.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Makefile`:
- Around line 99-105: The PR replaces gofmt with the golangci-lint formatter
causing cross-repo divergence; add a compatibility shim and documentation: keep
the Makefile targets fmt and gofmt (where gofmt is an alias to fmt using the
GOLANGCI_LINT variable) and add a short comment above them explaining the
standardization to golangci-lint fmt with gci import ordering, then update repo
README or CONTRIBUTING to state the new formatter and mention that gofmt target
remains for backward compatibility; reference the Makefile targets `fmt`,
`gofmt` and the `GOLANGCI_LINT` variable when making these edits.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: fd35aa9d-e2ea-4bca-9334-9088cfa80d0e
📒 Files selected for processing (15)
.golangci.yml.pre-commit-config.yamlAGENTS.mdCLAUDE.mdCONTRIBUTING.mdMakefilecmd/hyperfleet-e2e/common/config.gocmd/hyperfleet-e2e/test/cmd.godocs/architecture.mddocs/development.mddocs/getting-started.mdpkg/client/maestro/discovery.gopkg/helper/adapter.gopkg/helper/k8s.gopkg/helper/k8s_test.go
getting-started: fix nonexistent label-filter=critical to tier0, fix broken troubleshooting.md link, fix broken markdown block. development: fix test name format to [Suite:][category], switch cleanup examples to DeferCleanup, add e2e/adapter/ to imports, use h.TestDataPath(), fix dead links to nonexistent docs. architecture: remove nonexistent config field, fix RunTests signature, correct default poll interval, remove fabricated retry logic and wrong generated client example. CONTRIBUTING: add e2e/adapter/ to repo structure, fix cleanup to DeferCleanup, remove fabricated OPENAPI_SPEC_REF env var.
1 participant
Summary
Test Plan
make test-allpassesmake lintpassesmake test-helm(if applicable)