Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 3.11 KB

File metadata and controls

107 lines (76 loc) · 3.11 KB

AGENTS

Scope

  • This file guides agentic tools working in this repository.
  • It documents commands and style based on the current repo state.

Repository overview

  • Current top-level content: docs/.
  • Current reference document: docs/taskpaper-todotxt-mapping.md.
  • No application source code is present at this time.

Cursor and Copilot rules

  • No Cursor rules found in .cursor/rules/ or .cursorrules.
  • No Copilot instructions found in .github/copilot-instructions.md.
  • If these files are added later, follow them as higher priority.

Build, lint, and test commands

  • No build configuration found.
  • No lint configuration found.
  • No test runner configuration found.
  • Single test execution: not applicable.
  • If you add tooling, update this section with exact commands.

Code style and conventions

General

  • Use ASCII by default.
  • Introduce non-ASCII only when the file already uses it.
  • Keep changes minimal and consistent with existing content.
  • Prefer explicit, readable names over clever abbreviations.
  • Avoid speculative refactors without user request.

Markdown

  • Every document must have a single H1 title.
  • Keep one blank line after each heading.
  • Use - for bullets.
  • Avoid more than two bullet levels.
  • Keep bullets to one line when possible.
  • Use code spans for files, paths, and commands.
  • Use language identifiers in fenced code blocks.
  • Separate paragraphs and elements with a blank line.

Naming

  • Use lowercase names with hyphens.
  • Use the .md extension for documentation files.
  • Keep filenames descriptive and stable.

Formatting

  • Prefer short sentences and clear structure.
  • Avoid long paragraphs when bullets work.
  • Keep headings concise.
  • Avoid decorative formatting.

Imports, types, and error handling

  • No language-specific conventions available yet.
  • If code is added, mirror existing patterns in that language.
  • Do not invent new conventions without user guidance.

TaskPaper and todo.txt mapping doc

  • Keep the mapping spec accurate and consistent.
  • Treat parent: as authoritative hierarchy.
  • Treat path: as a denormalized header hint.
  • Preserve human readability in examples.
  • Keep examples minimal and focused.

Editing workflow

  • Read files before editing to match existing structure.
  • Use apply_patch for single-file edits when practical.
  • Avoid mass rewrites for small changes.
  • Do not edit unrelated files.

Tooling expectations

  • Use repository tools only when present.
  • Do not introduce new build steps without request.
  • Document any new tooling in this file.

When adding new code

  • Add a clear entry in Build, lint, and test commands.
  • Include a single-test example if possible.
  • Add code style rules specific to the language.
  • Add any formatting or lint tooling expectations.

Quality checklist

  • Changes are scoped to user request.
  • Documentation remains consistent with repo content.
  • Examples compile logically with the spec.
  • Commands are accurate and copy-paste ready.

Non-goals

  • No enforced opinions beyond repository content.
  • No speculative architecture or tooling.
  • No runtime behavior claims without evidence.