commit 572c007f5ddddc971e9f4cd83bbf02e38793e017 · anil.recoil.org/ocaml-jmap

+19

AGENT.md

···

       1
       +
       # Guidelines for the AI copilot editor.

     

       2
       +
       

     

       3
       +
       Whenever you generate any new OCaml functions, annotate that function's OCamldoc

     

       4
       +
       with a "TODO:claude" to indicate it is autogenerated. Do this for every function

     

       5
       +
       you generate and not just the header file.

     

       6
       +
       

     

       7
       +
       ## Project structure

     

       8
       +
       

     

       9
       +
       The `spec/rfc8620.txt` is the core JMAP protocol, which we are aiming to implement

     

       10
       +
       in OCaml code in this project. We must accurately capture the specification in the

     

       11
       +
       OCaml interface and never violate it without clear indication.

     

       12
       +
       

     

       13
       +
       ## Coding Instructions

     

       14
       +
       

     

       15
       +
       Read your instructions from this file, and mark successfully completed instructions

     

       16
       +
       with DONE so that you will know what to do next when reinvoked in the future.

     

       17
       +
       

     

       18
       +
       1. Define core OCaml type definitions corresponding to the JMAP protocol

     

       19
       +
          specification, in a new Jmap.Types module.