Skip to content

Commit e78aa34

Browse files
committed
adding example agents file
1 parent 69decfb commit e78aa34

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
## Setup/Packaging
3+
4+
- use `pnpm` over `npm` for package management
5+
- the `pnpm run test` commands also run the linter after tests
6+
- use `pnpm run -r format` (or individually in packages) to format code with prettier
7+
8+
## Documentation
9+
10+
- prefer verbose jsdoc comments for all public methods and classes
11+
- TypeDoc and vitepress will generate documentation from these comments in the `./docs/api` folder
12+
- module level jsdocs will be used for organization; for example packages/b2c-tooling/src/auth/index.ts barrel file has the module level docs for the `auth` module
13+
- see the typedoc.json file for configuration options including the entry points for documentation generation

0 commit comments

Comments
 (0)