You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Avoid bare words like `invalid`, `cannot`, `must`, or `failed` when they do not explain the fix. Prefer messages that include what was expected and, when helpful, an example.
14
13
15
14
✅ `invalid repo format 'gh-aw' — expected 'owner/repo' format (for example: 'github/gh-aw')`
16
15
@@ -24,18 +23,11 @@ Use `fmt.Errorf` for operational wrapping (`%w`) outside validation logic when y
24
23
25
24
## Error type selection
26
25
27
-
-`NewValidationError(...)`: bad input/config shape, missing fields, unsupported values.
-`fmt.Errorf(...%w...)`: wrap lower-level errors with actionable context.
26
+
Use `NewValidationError(...)` for bad input or config shape, missing fields, and unsupported values. Use `NewOperationError(...)` for runtime failures such as fetching, file IO, network, or command execution. Use `NewConfigurationError(...)` for safe-outputs and config wiring errors. Use `fmt.Errorf(...%w...)` to wrap lower-level errors with actionable context.
31
27
32
28
## Suggestion text requirements
33
29
34
-
Good suggestions:
35
-
36
-
1. Say what to change
37
-
2. Include a concrete YAML/code example
38
-
3. Prefer ✓/✗ examples when ambiguity is likely
30
+
Good suggestions say what to change, include a concrete YAML or code example, and use ✓/✗ examples when ambiguity is likely.
39
31
40
32
Example:
41
33
@@ -50,6 +42,4 @@ engine: unknown
50
42
51
43
## YAML example guidance
52
44
53
-
- Keep examples minimal and valid YAML
54
-
- Use real field names from frontmatter
55
-
- Quote only when required by YAML syntax
45
+
Keep examples minimal and valid YAML, use real field names from frontmatter, and quote only when required by YAML syntax.
0 commit comments