docs(claude): require Resolution hints on every StepFailureReport#800
Merged
Conversation
Every automa.StepFailureReport must include a
WithProperty(models.ErrPropertyResolution, []string{...}) block
listing operator-actionable steps. Added to Key Conventions so the
rule is enforced consistently across all future PRs.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Bruno Marques <bruno.marques@swirldslabs.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s contributor guidance to explicitly require resolution hints on all automa.StepFailureReport failures, so operators get actionable remediation steps surfaced in the TUI and error output.
Changes:
- Add a new coding standard to
CLAUDE.mdrequiringErrPropertyResolutionhints for everyautoma.StepFailureReport.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Bruno Marques <bruno.marques@swirldslabs.com>
alex-au
approved these changes
Jul 3, 2026
alex-au
left a comment
alex-au
left a comment
Contributor
There was a problem hiding this comment.
yes we should always do that
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a mandatory coding standard to
CLAUDE.md: everyautoma.StepFailureReportmust include a
WithProperty(models.ErrPropertyResolution, []string{...})blocklisting operator-actionable steps to resolve the failure.
This pattern is already consistent across the codebase — this entry makes it
explicit so it is enforced on all future PRs rather than caught in review.
Related Issues