Skip to content

Commit e10bca2

Browse files
committed
docs(agents): add mandatory style guide compliance section (#91)
1 parent 126240a commit e10bca2

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,26 @@ If the type system complains, fix the underlying issue.
9090

9191
If work must be deferred, create a GitHub issue. The issue IS the TODO.
9292

93+
### Style Guide Compliance
94+
95+
**MANDATORY: `STYLE_GUIDE.md` is not advisory — it is a blocking requirement.**
96+
97+
All code must comply with style rules. Violations are **blocking** and will fail adversarial review. No exceptions.
98+
99+
**Common violation categories:**
100+
101+
- No else statements — use early returns
102+
- No destructuring — preserve context
103+
- No let statements — use const with ternary operators
104+
- No semicolons in code
105+
- No type bypasses (`as any`, `@ts-ignore`, `@ts-expect-error`)
106+
- Prefer single-word variable names
107+
- Use Bun APIs (`Bun.file()`, `Bun.write()`)
108+
- No `try`/`catch` where early returns suffice
109+
- Keep functions flat and composable
110+
111+
**Reference:** See the "TypeScript Style Guide" section below for detailed code examples, and `STYLE_GUIDE.md` for complete rules and rationale.
112+
93113
---
94114

95115
## Pre-Push Verification
@@ -260,10 +280,17 @@ function process(data: unknown): Result {
260280
### No semicolons, minimal trailing commas
261281

262282
```typescript
283+
// Good
263284
const config = {
264285
name: "opencode",
265286
version: "1.0.0",
266287
}
288+
289+
// Bad
290+
const config = {
291+
name: "opencode",
292+
version: "1.0.0",
293+
};
267294
```
268295

269296
---

0 commit comments

Comments
 (0)