diff --git a/.agents/agents.md b/.agents/agents.md new file mode 100644 index 00000000..2f7507e9 --- /dev/null +++ b/.agents/agents.md @@ -0,0 +1,32 @@ +# react-simplemde-editor - Agent Guide + +This is the agent-facing guide for working in this repository. + +## Project Context +- React wrapper for simplemde (easymde) markdown editor + +## Setup +See [`agents.yaml`](./agents.yaml) for prerequisites, commands, and ports. + +### Setup Hints +- `nvm` may not be loaded in your shell. If `nvm: command not found`, source it first. +- `yarn dev` runs in the foreground — background it the same way. + +## Running the App +- Clone the repo +- Install: `yarn install` +- Dev: `yarn dev &` +- Access: `http://localhost:8080` + +## Architecture +- React wrapper for SimpleMDE/EasyMDE markdown editor +- Webpack for bundling +- Entry point: `src/index.js` + +## Working Agreement +- Write modular code +- Keep testable +- Incremental validation +- Commit meaningful checkpoints +- Write tests +- Validate before handoff diff --git a/.agents/agents.yaml b/.agents/agents.yaml new file mode 100644 index 00000000..ffd44408 --- /dev/null +++ b/.agents/agents.yaml @@ -0,0 +1,27 @@ +repo: + name: react-simplemde-editor + description: React wrapper for simplemde (easymde) markdown editor + owner: benrlodge + +prerequisites: + - name: GitHub CLI + - name: yarn + - name: node + version: '>=12.0.0' + +setup: + - yarn install + - yarn dev + +dev: + command: yarn dev + port: 8080 + +build: + command: yarn build + +test: + command: yarn test + +lint: + command: yarn lint