Skip to content

Commit ef2896f

Browse files
committed
feat(docs): add Copilot and AGENTS instructions for automation and project behavior
1 parent 62b8f8c commit ef2896f

2 files changed

Lines changed: 49 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Copilot Instructions
2+
3+
Follow the repo’s existing patterns and tooling:
4+
5+
- Use pnpm for scripts and installs.
6+
- Keep ESM imports/exports (`type: "module"`).
7+
- Prefer Vite library build for package output.
8+
- Use existing ESLint configs (root + `playground/`).
9+
- Keep build output under `dist/`.
10+
- Avoid changes to public APIs unless requested.
11+
12+
Helpful commands:
13+
- `pnpm lint`
14+
- `pnpm typecheck`
15+
- `pnpm build`
16+

AGENTS.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AGENTS
2+
3+
Use these instructions for automation and assistant behavior in this repo.
4+
5+
## Project overview
6+
7+
- Package: `@smakss/react-scroll-direction`
8+
- Build: Vite library build
9+
- Package manager: pnpm
10+
- Linting: ESLint (main + playground configs)
11+
12+
## Working rules
13+
14+
- Prefer pnpm scripts (`pnpm run <script>`).
15+
- Keep changes ESM-friendly (`type: "module"`).
16+
- Preserve existing file structure and naming conventions.
17+
- Avoid large refactors unless requested.
18+
- Keep output in `dist/` only.
19+
20+
## Commands
21+
22+
- Build: `pnpm build`
23+
- Lint (all): `pnpm lint`
24+
- Lint (main): `pnpm lint:main`
25+
- Lint (playground): `pnpm lint:playground`
26+
- Typecheck (all): `pnpm typecheck`
27+
- Typecheck (main): `pnpm typecheck:main`
28+
- Typecheck (playground): `pnpm typecheck:playground`
29+
30+
## Playground
31+
32+
- Location: `playground/`
33+
- Run dev server: `pnpm -C playground dev`

0 commit comments

Comments
 (0)