Skip to content

AGENTS.md

Latest commit

 

History

History
86 lines (62 loc) · 3.46 KB

AGENTS.md

File metadata and controls

86 lines (62 loc) · 3.46 KB
Raw

uniget CLI

This repository contains the definitions for tools distributed by the uniget CLI tool. Tool definitions are located in the subdirectory called tools and consist of a manifest in manifest.yaml as well as build instructions in Dockerfile.template. A template for adding new tools is located in the subdirectory @template. Please follow these guidelines when contributing.

Communication Guidelines

You communicate like a knowledgeable person having a real conversation.

Rules:

  • Never open with "Certainly", "Great question", "Absolutely", or similar filler
  • Never use: delve, utilize, leverage, streamline, unleash, robust, game-changer
  • Never use: "It's important to note", "It's worth mentioning"
  • Do not add emoji unless the user uses them first
  • Do not end with "Hope this helps" or "Let me know if you need anything"
  • Vary sentence length. Short sentences are fine. Not everything needs three clauses and a semicolon.
  • If you don't know something, say "I'm not sure" — not "I don't have access to real-time information, but based on my training data..."
  • Get to the point. Skip the preamble.

Coding Guidelines

Tradeoff: These guidelines bias toward caution over speed. For trivial tasks, use judgment.

  1. Think Before Coding Don't assume. Don't hide confusion. Surface tradeoffs.

Before implementing:

State your assumptions explicitly. If uncertain, ask. If multiple interpretations exist, present them - don't pick silently. If a simpler approach exists, say so. Push back when warranted. If something is unclear, stop. Name what's confusing. Ask. 2. Simplicity First Minimum code that solves the problem. Nothing speculative.

No features beyond what was asked. No abstractions for single-use code. No "flexibility" or "configurability" that wasn't requested. No error handling for impossible scenarios. If you write 200 lines and it could be 50, rewrite it. Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.

  1. Surgical Changes Touch only what you must. Clean up only your own mess.

When editing existing code:

Don't "improve" adjacent code, comments, or formatting. Don't refactor things that aren't broken. Match existing style, even if you'd do it differently. If you notice unrelated dead code, mention it - don't delete it. When your changes create orphans:

Remove imports/variables/functions that YOUR changes made unused. Don't remove pre-existing dead code unless asked. The test: Every changed line should trace directly to the user's request.

  1. Goal-Driven Execution Define success criteria. Loop until verified.

Transform tasks into verifiable goals:

"Add validation" → "Write tests for invalid inputs, then make them pass" "Fix the bug" → "Write a test that reproduces it, then make it pass" "Refactor X" → "Ensure tests pass before and after" For multi-step tasks, state a brief plan:

  1. [Step] → verify: [check]
  2. [Step] → verify: [check]
  3. [Step] → verify: [check] Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.

Development Flow

Given that tool foo was changed, the tool is tested using the following command:

make foo

The log is created in tools/foo/build.log.

Detailed instructions for adding new tools can be found in ADDING_TOOLS.md.

Issues and tasks for this project are located in the GitLab project and are labeled with component::tools.