dsh-context/AGENTS.md

dsh-context

A DeepSeek Harness plugin for context insight, actions, and management.

Background

• DeepSeek Harness:

  • an open-source agent harness developed by DeepSeek AI.
  • Dive deep in to the code when you are preparing for development
  • Github: deepseek-ai/deepseek-harness
  • NPM: @deepseek-ai/dsh
  • Local git clone of dsh:
    • may be found in the ~/dev/deepseek-harness directory
    • git pull on the main branch to update
    • commits and tags are available for reference and comparison

• DeepSeek Harness Plugin:

  • docs:
    • Reference: https://deepseek-harness.github.io/deepseek-harness/en/reference/
  • Example plugins:
    • Available on GitHub topic dsh-plugin: https://github.com/topics/dsh-plugin

Coding

• Always consider the minimal change and the most performance efficient implementation.
• Try best to use the existing classes, utilities, styles, events, presets and lifecycles provided by DeepSeek Harness.ess.
• Use English in code comments, documentation, Pull Request description, and commit messages.
• Smaller, less-coupling and modulized code and tests are preferred for better maintainability and testability.
• Avoid adding unnecessary code comments (unless for the pinned major decision or for those provide significant value) and code duplication.
• Before any commit, MUST ALWAYS do ALL the following checks:
  • Check the to-do list, and ensure all the items are properly completed or closed.
  • Review and simplify all the code changes, to ensure they are necessary, correct and not over-engineered.
  • Cleanup all temporary files. Cleanup temporary or unhelpful comments.
  • Run pnpm run lint:fix, to check and auto-fix code style and formatting.
  • Run pnpm run test, to run all tests, and ensure the code coverage is literally 100%.
  • Run pnpm run build, to ensure the code can be built successfully.

Building

• Run pnpm run build after code changes applied.
• Run pnpm run watch to keep hot-reloaded on dsh with local plugin installed. It also helps developer to see the code changes in the browser.

Dependency

• Consider updating the dependencies to the latest version if possible, as the deepseek-harness is evolving rapidly.

Compatibility

• Must be able to install and work correctly on @deepseek-ai/dsh 0.1.0-rc7+ and 0.1.1-rc2+ — no regressions in runtime dependencies, message parsing, or any user-visible behavior.
• Low-level logic (e.g. token counting) should track the implementation of the newest supported dsh version.

I18n

• Chinese (Simplified) and English are supported for UI elements.
• Update all the supported languages translations when adding or modifying the UI elements.
• Do not keep the deprecated or unused language keys.

Docs

• docs directory contains only end-user faced documents.
• docs/social-preview.png (GitHub social preview) must be exactly 1280 × 640 pixels.

Temp files

• Generate one-time temp files in the .tmp directory, and properly clean them up right after use.

Git

• When asked to commit, please commit the possibly mixed changes separately for each task or purpose.
• Push the commits automatically.

Workflow

• To-do list
  • Keep the coding agent's to-do list up to date throughout planning, investigation and implementation.
  • Before closing any task, review all pending to-do items and ensure each is completed, cleaned up or explicitly closed.

Tool Usage

• Always read the file first using the read tool before using the edit tool, which prevents errors like "Error: edit requires reading '/path/file' first — read the file, then retry."

Releasing

• Version X.Y.Z, 大版本.次版本.小版本。
• Releases are cut by tagging: git tag vX.Y.Z && gh release create vX.Y.Z.
• A GitHub Actions workflow then builds, tests, and publishes the package to npm automatically by github workflow. Agent don't have to do or check it manually.
• Write the release notes from the release template