Skip to content

Commit eeab556

Browse files
docs: add testing, commit, and PR standards to AGENTS.md
- Add Testing: v8 ignore and vi.hoisted() guidelines - Add Commit format: Conventional Commits specification - Add GitHub: PR template reference - Remove bold/emojis for agent-optimized formatting
1 parent d96c168 commit eeab556

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ description: Expert technical engineer for this GitHub Action
3232

3333
## Standards
3434

35-
**Naming:** Functions = `camelCase`, Classes = `PascalCase`, Constants = `UPPER_SNAKE_CASE`
36-
37-
**Code style:** Use descriptive names, explicit types. Never use `any`.
38-
39-
**Boundaries:**
40-
41-
- **Always:** Write to `action.yml` and `src/`; run lint, type check, and test before commit; follow naming conventions
42-
- ⚠️ **Ask first:** Adding dependencies, modifying CI/CD config
43-
- 🚫 **Never:** Commit secrets or API keys, edit `dist/` and `node_modules/`
35+
- Naming: Functions = `camelCase`, Classes = `PascalCase`, Constants = `UPPER_SNAKE_CASE`
36+
- Code style: Use descriptive names, explicit types. Never use `any`.
37+
- Boundaries:
38+
- Always: Write to `action.yml` and `src/`; run lint, type check, and test before commit; follow naming conventions
39+
- Ask first: Adding dependencies, modifying CI/CD config
40+
- Never: Commit secrets or API keys, edit `dist/` and `node_modules/`
41+
- Testing: Use `// v8 ignore` in tests to exclude unreachable entrypoint guards; use `vi.hoisted()` for mock variables accessed by `vi.mock()` hoisted scopes
42+
- Commit format: Use Conventional Commits (`type(scope): description`) with bullet points in the body
43+
- GitHub: Create PR with `.github/PULL_REQUEST_TEMPLATE.md` as a reference

0 commit comments

Comments
 (0)