Skip to content

chore: add AGENTS.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
darkrishabh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: add AGENTS.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# polite-retry

TypeScript library implementing retry strategies with Adaptive Retry Budgeting (ARB).

## Commands

```bash
npm run build # TypeScript compile → dist/
npm run test # Jest tests
npm run test:watch
npm run lint # ESLint
```

**CI order (see `.github/workflows/ci.yml`):** `lint → test → build`

## Project Structure

- `src/` — TypeScript source (index.ts is entry point)
- `dist/` — Build output (CommonJS + declarations)
- `src/*.test.ts` — Test files excluded from build

## Notes

- Tests use Jest with `jest.fn()` mocking
- ESLint allows `_` prefix for unused args/vars: `varsIgnorePattern: "^_"`
- `test:watch` uses `--watch` flag (jest default watch mode)
- Node >=16 required
Loading