Skip to content

docs: add AGENTS.md guidance #135

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

Merged
JustinBeckwith merged 2 commits into from
Apr 12, 2026
Merged

docs: add AGENTS.md guidance #135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d775f7
docs: add AGENTS.md guidance
JustinBeckwith Apr 12, 2026
613c102
docs: require conventional commits in AGENTS
JustinBeckwith Apr 12, 2026
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
36 changes: 36 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# AGENTS.md

## Project overview

- This repository is a small ESM Node.js package that exports a single middleware from `lib/index.js`.
- Runtime support starts at Node.js 18 (`package.json`), and CI tests the package on Node.js 18, 20, and 22.
- Linting runs with Biome, and releases are managed through `release-please`.

## Working agreements

- Use `npm` for dependency and script commands.
- Prefer small, focused changes. Avoid unrelated cleanup in the same PR.
- Use Conventional Commits for commit messages and PR titles (for example: `fix: ...`, `feat: ...`, `docs: ...`). This repository uses `release-please`, so incorrect commit or PR prefixes can break release automation.
- Keep the public middleware API and the README example aligned when behavior or options change.
- Do not edit `CHANGELOG.md` or `.release-please-manifest.json` manually unless the task is explicitly about the release process.

## Commands

- Install dependencies: `npm install`
- Run tests: `npm test`
- Run lint: `npm run lint`
- Auto-fix formatting and lint issues: `npm run fix`
- Generate coverage report: `npm run coverage`

## Testing notes

- `npm test` runs with `NODE_ENV=production`, which is important because the middleware bypasses redirects outside production mode.
- HTTPS behavior is covered in `test/test.js` using the certificates under `test/certs/`.
- If you change request handling or HSTS behavior, update or extend tests in `test/test.js`.

## Files to check during changes

- `lib/index.js`: package implementation and exported middleware.
- `test/test.js`: behavioral coverage for redirects, HSTS headers, and ignored routes.
- `README.md`: user-facing API and usage examples.
- `example/app.js`: example app for manual testing and docs alignment.
Loading