Skip to content

AGENTS.md

Latest commit

 

History

History
65 lines (44 loc) · 2.58 KB

AGENTS.md

File metadata and controls

65 lines (44 loc) · 2.58 KB

TaskNotes - Agent Development Guide

This is an Obsidian plugin. The plugin ID is tasknotes.

Build & Test

# Build the plugin and copy files to the vault's plugin directory
npm run build:test

# After building, reload the plugin in the running Obsidian instance
obsidian vault=test plugin:reload id=tasknotes

Always run both commands after making changes. Obsidian must be running for the CLI to work.

Useful Obsidian CLI Commands

# Check for JavaScript errors after reload
obsidian vault=test dev:errors

# View console output
obsidian vault=test dev:console

# Run JavaScript in the Obsidian context
obsidian vault=test eval code="app.vault.getFiles().length"

# Take a screenshot to verify UI changes
obsidian vault=test dev:screenshot path=screenshot.png

# Open developer tools
obsidian vault=test devtools

Other Build Commands

npm test              # Run unit tests (Jest)
npm run lint          # Lint source files
npm run typecheck     # TypeScript type checking only
npm run build         # Production build (without copying to vault)

Ensure all code changes pass linting checks. Do not weaken linting rules in order to get changes to pass.

When you make changes, update docs/releases/unreleased.md. If your changes are related to a GitHub issue or PR, include acknowledgement of the individual who opened the issue or submitted the PR. Do not update unreleased.md for the addition of tests; unreleased.md is user-facing.

You may update .ops/ files locally as you work on items, but do not commit .ops/ files. .ops/ is local-only working state.

Prepare for a release.

When asked to prepare for a release:

  1. Run through the @I18N_GUIDE.md and make sure translations are up-to-date (and in their target language--not English placeholders).
  2. Make sure ALL npm run test tests are passing.
  3. Make sure there are no linting errors.
  4. Make sure all items in @docs/releases/unreleased.md thank the correct issue/pr opener (double check), as well as those who have commented on the issue/pr. Make sure the copy is appropriate--it is user facing so it should not be overly technical. Make sure it is free from anything that resembles marketing copy. do not thank callumalpass
  5. Move the body of unreleased.md to .md, following the pattern of previous released. Leave the comments that explain unreleased.md inside unreleased.md.
  6. Update @manifest.json and @package.json.
  7. Commit changes as "release " (you can choose the version number unless it is specified).
  8. Tag the commit. (Just version number, no 'v' prefix.