Skip to content
ochat
Search documentation

Use quotes for an exact phrase.

Search by topic, command, or code identifier.

    GitHub ↗

    Review a change against the requirements

    Read a supplied patch and acceptance criteria, then produce findings tied to the changed lines.

    View Markdown source ↗
    ← All applications

    InputA sample diff and requirements

    OutputA review checklist with suggested tests

    Setup Installed Ochat, a configured provider with access to gpt-4.1 (or an edited supported model), and launch from the extracted directory. Model requests incur provider charges.

    Workflow overview · illustrative
    1. Read the requirement
    2. Inspect the change
    3. Explain the risk

    Read a supplied patch and acceptance criteria, then produce findings tied to the changed lines.

    Make your review checklist repeatable. Add a specialist or explicitly configured test command as a separate extension.

    Input: A sample diff and requirements.

    Output: A review checklist with suggested tests.

    Complete installation and provider setup, extract the change-review bundle, and run from its directory:

    Terminal window
    mkdir -p runs
    ochat chat-completion -prompt-file agent.chatmd -output-file runs/review-01.chatmd

    The prompt reads a small Python diff and the requirement to preserve internal spacing. The proposed "".join(name.split()) removes that spacing. A useful review identifies that mismatch and proposes a test such as an input containing a two-word name. The preview is an illustration, not a captured model review.

    Replace the diff and requirements with the change you want reviewed. Add project conventions to the instructions, and ask for evidence tied to changed lines. This prompt can inspect the supplied files but cannot run tests or modify code.

    Use the shell tutorial to configure a specific test command under the chosen host’s permissions. An agent declaration alone does not authorize execution. Keep static review findings separate from actual test results, and review proposed edits before applying them. A specialist agent can apply a separate review checklist.

    Explore another application or follow the tutorial curriculum.

    View source · Change review4 files

    Complete source files. Open a filename to read it here.

    agent.chatmdStart here
    <config model="gpt-4.1" max_tokens="1200"/>
    <tool name="read_file">
      <read id="reference" path="${workspace}/reference" description="Included example input files"/>
    </tool>
    <developer>Read requirements.txt and change.diff from the reference root. Review the supplied diff against the requirements. Cite the relevant changed line, explain any mismatch, and suggest a minimal test. You have no shell or editing tools; do not claim to run tests.</developer>
    <user>Review this proposed change before it is merged.</user>
    

    Link to this fileDownload this file

    reference/change.diffdata
    --- a/names.py
    +++ b/names.py
    @@ -1,2 +1,2 @@
     def normalize_name(name):
    -    return name
    +    return "".join(name.split())
    

    Link to this fileDownload this file

    reference/requirements.txtdata
    Function: normalize_name
    Trim leading and trailing whitespace. Preserve spacing inside the name. An empty or whitespace-only input returns an empty string.
    

    Link to this fileDownload this file

    LICENSE.txtnotice
    MIT License
    
    Copyright (c) 2025 
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.

    Link to this fileDownload this file