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 4 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 |
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR establishes code quality infrastructure, comprehensive E2E testing guidance, and import standardization. It configures golangci-lint with a gci formatter for import ordering, sets up pre-commit hooks for enforcing code standards, and refactors the Makefile to use golangci-lint instead of gofmt. A new AGENTS.md document provides detailed black-box instructions for writing E2E tests, covering conventions for naming, cleanup patterns, async operations, and runtime gotchas. Documentation is updated across CONTRIBUTING.md, development.md, architecture.md, and getting-started.md to reflect new test naming conventions with baseline categories, DeferCleanup cleanup patterns, and refreshed example commands. Go import ordering is standardized across multiple files to align with the gci formatter rules. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsLinked repositories: Couldn't analyze Linked repositories: Couldn't analyze 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.
Add .pre-commit-config.yaml using hyperfleet-hooks v0.2.1 (commitlint, gofmt, golangci-lint, go-vet). Add gci formatter to golangci-lint config with 4-group import ordering: stdlib, external, openshift-hyperfleet, hyperfleet-e2e. Switch make fmt/fmt-check to use golangci-lint fmt. Add make gofmt/go-vet aliases for hook compatibility. Remove unused GOFMT variable.
Run golangci-lint fmt --fix to separate openshift-hyperfleet org imports from hyperfleet-e2e local imports.
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.
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
| .PHONY: fmt | ||
| fmt: ## Format Go code | ||
| $(GOFMT) -s -w . | ||
| fmt: $(GOLANGCI_LINT) ## Format Go code and imports | ||
| $(GOLANGCI_LINT) fmt ./... | ||
|
|
||
| .PHONY: gofmt | ||
| gofmt: fmt ## Alias for fmt | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Cross-repo formatting tool divergence.
Linked repositories (hyperfleet-api, hyperfleet-sentinel, hyperfleet-broker) still reference gofmt in their Makefiles and golangci configs. This PR standardizes on golangci-lint fmt with gci import ordering, which may create different developer experiences across repositories. Consider documenting this transition or coordinating formatting standards across the HyperFleet organization.
🤖 Prompt for 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.
In `@Makefile` around lines 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.
1 participant
Summary
Test Plan
make test-allpassesmake lintpassesmake test-helm(if applicable)