Skip to content

Commit c430195

Browse files
authored
chore: add format and lint to .md guides (#4057)
1 parent 12352a0 commit c430195

4 files changed

Lines changed: 21 additions & 5 deletions

File tree

.claude/REVIEW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Every PR gets a performance pass — not just the ones that look perf-sensitive.
6565

6666
## Skip (do NOT flag)
6767

68-
- Anything Prettier / ESLint catches. CI runs both.
68+
- Anything oxfmt / oxlint catches. CI enforces both via the `code-quality` check.
6969
- TypeScript style preferences (`type` vs `interface`) — already covered by repo standards.
7070
- Test coverage exhortations as a generic suggestion. Only flag missing tests when a specific code path is genuinely untested and the path has prior incidents.
7171
- `agentcrumbs` markers (`// @crumbs`, `// #region @crumbs`) and `agentcrumbs` imports — these are temporary debug instrumentation stripped before merge.

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ For full setup instructions see `CONTRIBUTING.md`.
5555
Refer to `ai/references/tests.md` for details on writing tests. Tests should avoid mocks or stubs and use the helpers from `@internal/testcontainers` when Redis or Postgres are needed.
5656

5757
## Coding style
58-
- Formatting is enforced using Prettier. Run `pnpm run format` before committing.
58+
- Formatting is enforced using oxfmt. Run `pnpm run format` before committing.
5959
- Follow the existing project conventions. Test files live beside the files under test and use descriptive `describe` and `it` blocks.
6060
- Do not commit directly to the `main` branch. All changes should be made in a separate branch and go through a pull request.
6161

CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,16 @@ containerTest("should use both", async ({ prisma, redisOptions }) => {
7171

7272
## Code Style
7373

74+
### Formatting and linting
75+
76+
Format and lint are enforced by CI (`code-quality` check). Run before committing:
77+
78+
```bash
79+
pnpm run format # oxfmt — auto-fixes formatting
80+
pnpm run lint:fix # oxlint — auto-fixes lint violations
81+
pnpm run lint # oxlint — check only (no fixes)
82+
```
83+
7484
### Imports
7585

7686
**Prefer static imports over dynamic imports.** Only use dynamic `import()` when:

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,15 @@ pnpm exec trigger dev --log-level debug
223223
### PR workflow
224224

225225
1. **Always open your PR in draft status first.** Do not mark it as "Ready for Review" until the steps below are complete.
226-
2. **Address all CodeRabbit code review comments.** Our CI runs an automated code review via CodeRabbit. Go through each comment and either fix the issue or resolve it with a comment explaining why no change is needed.
227-
3. **Wait for all CI checks to pass.** Do not mark the PR as "Ready for Review" until every check is green.
228-
4. **Then mark the PR as "Ready for Review"** so a maintainer can take a look.
226+
2. **Run format and lint locally before pushing:**
227+
```bash
228+
pnpm run format # auto-fixes formatting (oxfmt)
229+
pnpm run lint:fix # auto-fixes lint violations (oxlint)
230+
```
231+
Both are enforced by CI — the `code-quality` check will fail if either produces a diff or errors.
232+
3. **Address all CodeRabbit code review comments.** Our CI runs an automated code review via CodeRabbit. Go through each comment and either fix the issue or resolve it with a comment explaining why no change is needed.
233+
4. **Wait for all CI checks to pass.** Do not mark the PR as "Ready for Review" until every check is green.
234+
5. **Then mark the PR as "Ready for Review"** so a maintainer can take a look.
229235

230236
### Cost/benefit analysis for risky changes
231237

0 commit comments

Comments
 (0)